-
Notifications
You must be signed in to change notification settings - Fork 482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update geps/overview.md - fix a broken link in geps/overview.md #3386
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: joerober The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hi @joerober. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the 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. |
@joerober Hey, thanks for looking into this! That said -- if I look at https://gateway-api.sigs.k8s.io/geps/overview/, the "graduation criteria" link works for me. Can you doublecheck? or let us know what browser and such you're having an issue with? |
@kflynn the link was broken from here: https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/overview.md#5-graduate-the-gep-to-standard |
@joerober Ah, I get it. You're viewing the source directly, rather than the rendered pages -- the links are constructed to do the right thing when viewed from the Gateway API website, and it does work from https://gateway-api.sigs.k8s.io/geps/overview/ as it should. 🤔 I don't know of a way to build these so that the links work from both (in the rendered version, this is no longer a Markdown file, so linking directly to the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will break the rendered page on the website, as described above, so we need to find a different answer here. 🙂
/hold just in case. 🙂 |
@kflynn Documentation is within Gateway API developer guide: https://gateway-api.sigs.k8s.io/contributing/devguide/#documentation You are correct that my edit breaks the page. I now see that there is a 'deploy/netlify - Deploy Preview ready!' within this PR (I had to scroll to the bottom of 'All checks') I'll look at this with the mkdocs live preview server (as described in guide) to if or how to fix in both source and rendered pages. |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This fixes a broken link in geps/overview.md file.
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: