gateway-api icon indicating copy to clipboard operation
gateway-api copied to clipboard

Update geps/overview.md - fix a broken link in geps/overview.md

Open joerober opened this issue 1 year ago • 7 comments

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

joerober avatar Oct 10 '24 01:10 joerober

[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 avatar Oct 10 '24 01:10 k8s-ci-robot

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 avatar Oct 10 '24 01:10 k8s-ci-robot

@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 avatar Oct 10 '24 02:10 kflynn

@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 avatar Oct 10 '24 13:10 joerober

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

kflynn avatar Oct 10 '24 13:10 kflynn

/hold

just in case. 🙂

kflynn avatar Oct 10 '24 13:10 kflynn

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

joerober avatar Oct 10 '24 19:10 joerober

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jan 08 '25 19:01 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Feb 07 '25 20:02 k8s-triage-robot

Sounds like there's nothing to do here just now so I'll consider this one closed,

/close

However, please feel free to re-open when you're ready!

shaneutt avatar Feb 12 '25 22:02 shaneutt