Skip to content

Docs: route rule name #3299

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Sep 30, 2024
Merged

Docs: route rule name #3299

merged 3 commits into from
Sep 30, 2024

Conversation

guicassolato
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

  • Moves GEP-995: Named route rules to Experimental
  • Fixes the description of the format for route rule names in the GEP
  • Documents the name field of route rule types in the Reference > API Types section of the website

Which issue(s) this PR fixes:

Fixes #3298

Does this PR introduce a user-facing change?:

Add documentation for route rule names

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 27, 2024
@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) needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 27, 2024
@k8s-ci-robot
Copy link
Contributor

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

@robscott
Copy link
Member

Thanks @guicassolato!

/ok-to-test
/approve
/hold for v1.2 release

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 30, 2024
@robscott robscott added this to the v1.2.0 milestone Aug 30, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: guicassolato, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 added approved Indicates a PR has been approved by an approver from all required OWNERS files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Aug 30, 2024
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 2, 2024
@guicassolato
Copy link
Contributor Author

/retest

@youngnick
Copy link
Contributor

/lgtm

thanks @guicassolato!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2024
@shaneutt shaneutt self-requested a review September 18, 2024 13:18
@shaneutt shaneutt added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Sep 18, 2024
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 26, 2024
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 27, 2024
@youngnick
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 30, 2024
@youngnick
Copy link
Contributor

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 30, 2024
@k8s-ci-robot k8s-ci-robot merged commit 076d830 into kubernetes-sigs:main Sep 30, 2024
13 checks passed
blake added a commit to blake/gateway-api that referenced this pull request Feb 6, 2025
@blake
docs: Fix incorrectly rendered links on site
0126fb6 
This commit fixes a few links that were incorrectly being rendered as
markdown instead of HTML anchors, or were pointing to outdated URL
paths.

* Fix broken anchor link in GEP-713. Missed in kubernetes-sigs#2448 when section header
  was updated.
* Fix broken link to GEP States in GEP-91. Page was moved to a new
  location in kubernetes-sigs#1440 and section heading was renamed in kubernetes-sigs#2689.
* Fix broken link to GRPCRouteRule.Name in docs for GRPCRoute API type.
  Missed in kubernetes-sigs#3299.

Signed-off-by: Blake Covarrubias <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LiorLieberman LiorLieberman Awaiting requested review from LiorLieberman

@mlavacca mlavacca Awaiting requested review from mlavacca

@shaneutt shaneutt Awaiting requested review from shaneutt

Assignees

@youngnick youngnick

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
No open projects
Gateway API Pipeline
Status: Done
Milestone
v1.2.0
Development

Successfully merging this pull request may close these issues.

Documentation for the name field of route rules
5 participants
@guicassolato @k8s-ci-robot @robscott @youngnick @shaneutt