[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175: URL: https://github.com/apache/apisix/pull/4175#discussion_r625560772 ## File path: docs/en/latest/plugins/authz-keycloak.md ## @@ -42,9 +42,9 @@ For more information on Keycloak, refer to [Keycloak Authorization Docs](https:/ | Name | Type | Requirement | Default | Valid | Description | | -- | - | --- | - | -- | --- | -| discovery | string| optional| | https://host.domain/auth/realms/foo/.well-known/uma2-configuration | URL to discovery document for Keycloak Authorization Services. | -| token_endpoint | string| optional| | https://host.domain/auth/realms/foo/protocol/openid-connect/token | A OAuth2-compliant Token Endpoint that supports the `urn:ietf:params:oauth:grant-type:uma-ticket` grant type. Overrides value from discovery, if given. | -| resource_registration_endpoint | string| optional| | https://host.domain/auth/realms/foo/authz/protection/resource_set | A Keycloak Protection API-compliant resource registration endpoint. Overrides value from discovery, if given. | +| discovery | string| optional| | `https://host.domain/auth/realms/foo/.well-known/uma2-configuration` | URL to discovery document for Keycloak Authorization Services. | Review comment: > It would be more helpful to me if you @spacewander explain me why you used (``) http://127.0.0.1:9080/apisix/dashboard/ in apisix.apache.org/docs/apisix/plugins/limit-req#how-to-enable-on-the-route-or-serivce. You should not ask me. If you know how to use `git blame`, you can see **every lines in this page is not written by me**. How can I answer you? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625542469
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
And this problem should be fixed by the doc render framework itself.
Adding unrelative doc to the sidebar to fix it is **a hack**.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625541979
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
Not all pages need a sidebar. They can go back from the browser.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625513277
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
Don't add it to the sidebar. It doesn't belong to that.
Please revert the change.
Please explain yourself clearly when submitting the change.
I don't even know why you want to add it to the sidebar.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175: URL: https://github.com/apache/apisix/pull/4175#discussion_r625512291 ## File path: docs/en/latest/plugins/authz-keycloak.md ## @@ -42,9 +42,9 @@ For more information on Keycloak, refer to [Keycloak Authorization Docs](https:/ | Name | Type | Requirement | Default | Valid | Description | | -- | - | --- | - | -- | --- | -| discovery | string| optional| | https://host.domain/auth/realms/foo/.well-known/uma2-configuration | URL to discovery document for Keycloak Authorization Services. | -| token_endpoint | string| optional| | https://host.domain/auth/realms/foo/protocol/openid-connect/token | A OAuth2-compliant Token Endpoint that supports the `urn:ietf:params:oauth:grant-type:uma-ticket` grant type. Overrides value from discovery, if given. | -| resource_registration_endpoint | string| optional| | https://host.domain/auth/realms/foo/authz/protection/resource_set | A Keycloak Protection API-compliant resource registration endpoint. Overrides value from discovery, if given. | +| discovery | string| optional| | `https://host.domain/auth/realms/foo/.well-known/uma2-configuration` | URL to discovery document for Keycloak Authorization Services. | Review comment: I can't understand what you mean. Does adding '``' make things different? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #4175: docs: fix broken links and ids in plugins
spacewander commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625455517
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
This section is not part of the category.
##
File path: docs/en/latest/plugins/skywalking.md
##
@@ -101,7 +101,7 @@ plugin_attr:
skywalking:
service_name: APISIX
service_instance_name: "APISIX Instance Name"
-endpoint_addr: http://127.0.0.1:12800
+endpoint_addr: `http://127.0.0.1:12800`
Review comment:
Don't blindly add '``'.
##
File path: docs/en/latest/plugins/authz-keycloak.md
##
@@ -42,9 +42,9 @@ For more information on Keycloak, refer to [Keycloak
Authorization Docs](https:/
| Name | Type | Requirement | Default
| Valid
| Description
|
| -- | - | --- |
- |
-- |
---
|
-| discovery | string| optional|
|
https://host.domain/auth/realms/foo/.well-known/uma2-configuration | URL to
discovery document for Keycloak Authorization Services.
|
-| token_endpoint | string| optional|
|
https://host.domain/auth/realms/foo/protocol/openid-connect/token | A
OAuth2-compliant Token Endpoint that supports the
`urn:ietf:params:oauth:grant-type:uma-ticket` grant type. Overrides value from
discovery, if given. |
-| resource_registration_endpoint | string| optional|
|
https://host.domain/auth/realms/foo/authz/protection/resource_set | A Keycloak
Protection API-compliant resource registration endpoint. Overrides value from
discovery, if given. |
+| discovery | string| optional|
|
`https://host.domain/auth/realms/foo/.well-known/uma2-configuration` | URL to
discovery document for Keycloak Authorization Services.
|
Review comment:
Why add '``' surround the link?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
