docs: Add API specification links to user guides
docs: Add API specification links to user guides
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR adds links to the API specification from user guides, making it easier for users to navigate from guide documentation to the detailed API reference for the types and fields being discussed.
Which issue(s) this PR fixes:
Fixes #4347
Description:
Added API specification links to 10 user guide files, linking relevant API types to their definitions in the generated API reference documentation. Each link points to ../reference/spec.md#gateway.networking.k8s.io/v1.<TypeName> following the established pattern used elsewhere in the documentation.
Files Modified:
-
site-src/guides/getting-started/simple-gateway.md
- Added links for:
Gateway,GatewayClass,ParentReference,HTTPBackendRef
- Added links for:
-
site-src/guides/grpc-routing.md
- Added link for:
GRPCRoute
- Added link for:
-
site-src/guides/http-cors.md
- Added link for:
HTTPCORSFilter
- Added link for:
-
site-src/guides/http-header-modifier.md
- Added links for:
HTTPHeaderFilter(for both RequestHeaderModifier and ResponseHeaderModifier)
- Added links for:
-
site-src/guides/http-method-matching.md
- Added link for:
HTTPRouteMatch
- Added link for:
-
site-src/guides/http-query-param-matching.md
- Added link for:
HTTPQueryParamMatch
- Added link for:
-
site-src/guides/http-request-mirroring.md
- Added link for:
HTTPRequestMirrorFilter
- Added link for:
-
site-src/guides/http-timeouts.md
- Added link for:
HTTPRouteTimeouts
- Added link for:
-
site-src/guides/tls.md
- Added links for:
Listener,GatewayTLSConfig,BackendTLSPolicy
- Added links for:
-
site-src/guides/traffic-splitting.md
- Added link for:
HTTPBackendRef
- Added link for:
Added API specification links to user guide documentation for easier navigation to API reference.
The committers listed above are authorized under a signed CLA.
- :white_check_mark: login: YASHMAHAKAL / name: Yash Vilas Mahakal (1fb513e09329cbed1039e718a340030714254aa6, 28c1a9009e69ff724be528e0fa6b95f3fb01d566, b9db27cf0e2adc6aba8c5a80ccbef96e5300e119, c1beccbba3b9021777b35a62a509f91a9745fdd7, d732e5d765da222971239ebb653179c21c0d4ce6, e5021f2092023de7ed63181863cd4bb3480ceb5b)
[APPROVALNOTIFIER] This PR is NOT APPROVED
This pull-request has been approved by: YASHMAHAKAL Once this PR has been reviewed and has the lgtm label, please assign thockin for approval. For more information see the Code Review Process.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
Welcome @YASHMAHAKAL!
It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.
You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.
You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.
You may want to refer to our testing guide if you run into trouble with your tests not passing.
If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!
Thank you, and welcome to Kubernetes. :smiley:
Hi @YASHMAHAKAL. Thanks for your PR.
I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.
/ok-to-test
greetings @rikatz !! Thank you for your review and suggestions, i'll be making corrections as suggested...Anything else you expect regarding the changes or any advice ??
Greetings @rikatz, As per your suggestions, i've made required appropriate corrections... Would like to know if anything still wrong : )