[GitHub] [apisix] KishaniKandasamy commented on a change in pull request #4175: docs: fix broken links and ids in plugins
KishaniKandasamy commented on a change in pull request #4175: URL: https://github.com/apache/apisix/pull/4175#discussion_r625550360 ## 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 thought ,If a phrase doesn't direct to any page ,we could better go with `` rather than explicitly showing it as a link,,something like   It would be more helpful to me if you @spacewander explain me why you used (``) `http://127.0.0.1:9080/apisix/dashboard/` in https://apisix.apache.org/docs/apisix/plugins/limit-req#how-to-enable-on-the-route-or-serivce. As I really don't know how to explain this, I would like to request @juzhiyuan too to review this PR ;) -- 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] KishaniKandasamy commented on a change in pull request #4175: docs: fix broken links and ids in plugins
KishaniKandasamy commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625540565
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
So when visitors see this page
https://apisix.apache.org/docs/apisix/examples/plugins-hmac-auth-generate-signature,
how could they see other menus?
--
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] KishaniKandasamy commented on a change in pull request #4175: docs: fix broken links and ids in plugins
KishaniKandasamy commented on a change in pull request #4175:
URL: https://github.com/apache/apisix/pull/4175#discussion_r625503789
##
File path: docs/en/latest/config.json
##
@@ -162,6 +162,13 @@
"discovery/eureka"
]
},
+{
+ "type": "category",
+ "label": "Examples",
Review comment:
then Shall I add this directly to the sidebar?I don't know how to add
https://github.com/apache/apisix/blob/master/docs/en/latest/examples/plugins-hmac-auth-generate-signature.md
tor.Sorry
--
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] KishaniKandasamy commented on a change in pull request #4175: docs: fix broken links and ids in plugins
KishaniKandasamy commented on a change in pull request #4175: URL: https://github.com/apache/apisix/pull/4175#discussion_r625500678 ## 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 '``'. OOOkay -- 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] KishaniKandasamy commented on a change in pull request #4175: docs: fix broken links and ids in plugins
KishaniKandasamy commented on a change in pull request #4175: URL: https://github.com/apache/apisix/pull/4175#discussion_r625500422 ## 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 thought they are just **valid url format** and it seems they don't direct to anywhere.   -- 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
