Skip to content

Grouping GEPs by status, cleaning up GEP related docs#1440

Merged
k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
robscott:geps-restructure
Oct 17, 2022
Merged

Grouping GEPs by status, cleaning up GEP related docs#1440
k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
robscott:geps-restructure

Conversation

@robscott
Copy link
Copy Markdown
Member

@robscott robscott commented Oct 6, 2022

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR includes a lot of GEP related cleanup, including:

  • Grouping GEPs by status
  • Moving contributing/geps to geps/overview
  • Cleaning up GEP related docs and adding more details
  • Replacing the "Implemented" status with new "Experimental" and "Standard" states
  • Adding definitions for each possible state
  • Updating GEPs that had stale status

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 6, 2022
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 6, 2022
shaneutt
shaneutt approved these changes Oct 7, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@shaneutt shaneutt left a comment •
edited
Loading

Choose a reason for hiding this comment

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

In favor. One comment about scratch docs which I hope I can persuade others about, but I don't consider it a blocker for merging this.

Comment thread site-src/geps/overview.md
Comment thread site-src/geps/overview.md
Comment thread site-src/geps/overview.md
Comment thread site-src/geps/overview.md Outdated
@shaneutt shaneutt requested a review from youngnick October 7, 2022 19:04
@robscott robscott mentioned this pull request Oct 10, 2022
Closed
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 11, 2022
mikemorris
mikemorris approved these changes Oct 11, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@mikemorris mikemorris left a comment

Choose a reason for hiding this comment

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

LGTM with very minor revisions, holding the final merge just to ensure other maintainers can weigh in too.

Comment thread mkdocs.yml
Comment thread site-src/geps/overview.md
Comment thread site-src/geps/overview.md Outdated
Comment thread site-src/geps/overview.md Outdated
Comment thread site-src/geps/overview.md Outdated
@youngnick
Copy link
Copy Markdown
Contributor

youngnick commented Oct 13, 2022

This LGTM once @mikemorris' comments are sorted.

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 15, 2022
@robscott
Copy link
Copy Markdown
Member Author

robscott commented Oct 15, 2022

Thanks for the reviews! Responded to everything, PTAL.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 15, 2022
@youngnick
Copy link
Copy Markdown
Contributor

youngnick commented Oct 17, 2022

/lgtm

Not sure if I'll need to do that again once you rebase.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2022
@robscott
Grouping GEPs by status, cleaning up GEP related docs
d5bdaf5 
This also replaces the "Implemented" status with new "Experimental" and
"Standard" states that make it clearer how far a GEP has made it. Some
GEPs had not properly updated their status, this ensures that all GEPs
have an accurate status.
@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 Oct 17, 2022
@robscott
Copy link
Copy Markdown
Member Author

robscott commented Oct 17, 2022

Thanks for the reviews @shaneutt @mikemorris and @youngnick! Mind taking one more look after latest rebase?

shaneutt
shaneutt approved these changes Oct 17, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2022
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Oct 17, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikemorris, robscott, shaneutt

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

The pull request process is described here

Details 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 merged commit bb714e0 into kubernetes-sigs:main Oct 17, 2022
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 <bcovarrubias@google.com>
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 <bcovarrubias@google.com>
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 <bcovarrubias@google.com>
@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 <bcovarrubias@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hbagdi hbagdi Awaiting requested review from hbagdi

@youngnick youngnick Awaiting requested review from youngnick

2 more reviewers

@mikemorris mikemorris mikemorris approved these changes

@shaneutt shaneutt shaneutt approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@shaneutt shaneutt

@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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@robscott @youngnick @k8s-ci-robot @mikemorris @shaneutt