Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

joerober
Copy link

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?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Oct 10, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: joerober
Once this PR has been reviewed and has the lgtm label, please assign danwinship for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested a review from kflynn October 10, 2024 01:01
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 10, 2024
@k8s-ci-robot k8s-ci-robot requested a review from mlavacca October 10, 2024 01:01
@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/gep PRs related to Gateway Enhancement Proposal(GEP) labels Oct 10, 2024
@k8s-ci-robot
Copy link
Contributor

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 /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.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 10, 2024
@kflynn
Copy link
Contributor

kflynn commented Oct 10, 2024

@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?

@joerober
Copy link
Author

@kflynn
Copy link
Contributor

kflynn commented Oct 10, 2024

@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 .md isn't appropriate). Any suggestions for how we might better point people looking at the sources to the rendered pages?

Copy link
Contributor

@kflynn kflynn left a 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. 🙂

@kflynn
Copy link
Contributor

kflynn commented Oct 10, 2024

/hold

just in case. 🙂

@joerober
Copy link
Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants