Skip to content

Add GEP-2659 and updates to GEP overview #2689

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 13 commits into from
Dec 22, 2023
Merged

Add GEP-2659 and updates to GEP overview #2689

merged 13 commits into from
Dec 22, 2023

Conversation

youngnick
Copy link
Contributor

@youngnick youngnick commented Dec 19, 2023 •
edited
Loading

What type of PR is this?
/kind documentation
/kind gep

What this PR does / why we need it:
This adds GEP-2659 to update the GEP process.

It also makes some changes to GEP layout:

  • GEPs are now stored in individual directories.
  • Each GEP now has a YAML metadata file. The schema is documented in pkg/gep.
  • All existing GEPs have had their YAML metadata fillled out.

Which issue(s) this PR fixes:
Fixes #2659

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. kind/gep PRs related to Gateway Enhancement Proposal(GEP) cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 19, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: youngnick

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 requested a review from bowei December 19, 2023 00:29
@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 19, 2023
@k8s-ci-robot k8s-ci-robot requested a review from gcs278 December 19, 2023 00:29
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 19, 2023
@youngnick youngnick requested review from robscott and removed request for bowei December 19, 2023 00:29
@youngnick
Copy link
Contributor Author

/hold for multiple review

robscott
robscott reviewed Dec 19, 2023
View reviewed changes
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @youngnick! Didn't quite make it through everything, but lots of great things in here.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 19, 2023
@youngnick
Add GEP-2659 and updates to GEP overview
d9d1373 
This commit adds the text of GEP-2659 and updates the GEP overview
with those details.

Signed-off-by: Nick Young <[email protected]>
@youngnick
Adds types for the GEPDetail YAML file
07221a4 
Signed-off-by: Nick Young <[email protected]>
@youngnick
Add YAML files for all existing GEPs
316b832 
Signed-off-by: Nick Young <[email protected]>
@youngnick
Fix overview formatting and table of contents
0c12e23 
Signed-off-by: Nick Young <[email protected]>
@youngnick
Fix spelling and explain references
1bc5fdb 
Signed-off-by: Nick Young <[email protected]>
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 20, 2023
robscott
robscott reviewed Dec 21, 2023
View reviewed changes
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @youngnick! A few nits but otherwise LGTM. I think it's great to get this in while there are very few changes in flight because this would otherwise result in a lot of merge conflicts. Will give a chance for others to weigh in over the next ~24 hours, but otherwise will plan to merge once that passes + this last bit of feedback has been addressed.

@youngnick
Fix PR comments
167cd6c 
Signed-off-by: Nick Young <[email protected]>
@robscott
Copy link
Member

Thanks @youngnick! This LGTM, but will hold off on merging for another ~24 hours in case someone else has feedback here.

/cc @mikemorris @mlavacca

This was referenced Dec 22, 2023
Merged
Closed
Merged
Merged
Merged
Closed
Closed
Closed
@robscott robscott added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Dec 22, 2023
@robscott
Copy link
Member

Thanks @youngnick!

/lgtm
/hold cancel

@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 Dec 22, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 22, 2023
@k8s-ci-robot k8s-ci-robot merged commit f80f447 into kubernetes-sigs:main Dec 22, 2023
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]>
blake added a commit to blake/gateway-api that referenced this pull request Mar 3, 2025
@blake
docs: Fix broken links on site
186b5d7 
This commit fixes a few links that were incorrectly being rendered as
markdown instead of HTML anchors, or were pointing to invalid URLs.

* Fixed a broken anchor link in GEP-713. Missed in kubernetes-sigs#2448 when section header
  was updated.
* Fixed a 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.
* Fixed link to policy attachment docs in GEP-1323.
* Fixed link to ListenerSets GitHub issue in GEP-1713.
* Fixed link to Envoy's RequestMirrorPolicy route action in GEP-3171.

Signed-off-by: Blake Covarrubias <[email protected]>
blake added a commit to blake/gateway-api that referenced this pull request Mar 3, 2025
@blake
docs: Fix broken links on site
09a38dd 
This commit fixes a few links that were incorrectly being rendered as
markdown instead of HTML anchors, or were pointing to invalid URLs.

* Fixed a 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.
* Fixed a broken anchor link in GEP-713. Missed in kubernetes-sigs#2448 when section header
  was updated.
* Fixed link to policy attachment docs in GEP-1323.
* Fixed link to ListenerSets GitHub issue in GEP-1713.
* Fixed link to Envoy's RequestMirrorPolicy route action in GEP-3171.
* Fixed link to Flomesh Gateway API on implementations page.

Signed-off-by: Blake Covarrubias <[email protected]>
@blake blake mentioned this pull request Mar 3, 2025
Merged
k8s-ci-robot pushed a commit that referenced this pull request Mar 4, 2025
@blake
docs: Fix broken links on site (#3655)
946c500 
This commit fixes a few links that were incorrectly being rendered as
markdown instead of HTML anchors, or were pointing to invalid URLs.

* Fixed a broken link to GEP States in GEP-91. Page was moved to a new
  location in #1440 and section heading was renamed in #2689.
* Fixed a broken anchor link in GEP-713. Missed in #2448 when section header
  was updated.
* Fixed link to policy attachment docs in GEP-1323.
* Fixed link to ListenerSets GitHub issue in GEP-1713.
* Fixed link to Envoy's RequestMirrorPolicy route action in GEP-3171.
* Fixed link to Flomesh Gateway API on implementations page.

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

@robscott robscott robscott left review comments

@gcs278 gcs278 Awaiting requested review from gcs278

@mikemorris mikemorris Awaiting requested review from mikemorris

@mlavacca mlavacca Awaiting requested review from mlavacca

Assignees

@robscott robscott

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. release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

GEP: Document and improve the GEP process
3 participants
@youngnick @k8s-ci-robot @robscott