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

chore(docs): geps README.md created #2640

Closed
wants to merge 1 commit into from

Conversation

mlavacca
Copy link
Member

@mlavacca mlavacca commented Dec 4, 2023

What type of PR is this?

/kind documentation

What this PR does / why we need it:

A GEP README.md is created, to allow easier navigation and lookup of the needed GEPs.

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Dec 4, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mlavacca
Once this PR has been reviewed and has the lgtm label, please assign robscott 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 added the kind/gep PRs related to Gateway Enhancement Proposal(GEP) label Dec 4, 2023
@robscott
Copy link
Member

robscott commented Dec 4, 2023

Thanks @mlavacca! A few questions:

  1. Is this intended to be the main page for GEPs? It currently shows up in https://deploy-preview-2640--kubernetes-sigs-gateway-api.netlify.app/geps/, but that's not accessible via navigation.
  2. Why aren't these grouped by stability level like the navigation?
  3. I'm very concerned that this list will grow stale, similar to what already happens with or GEP navigation in mkdocs.yml where it's easy to forget to make a change. Is there any kind of automation you can add to mitigate that?

@tao12345666333
Copy link
Member

+1 For this type of file, it is best to allow it to be automatically generated

@youngnick
Copy link
Contributor

Yeah, I agree that a TOC like this should be autogenerated. Great idea though.

@mlavacca
Copy link
Member Author

mlavacca commented Dec 5, 2023

Thanks @mlavacca! A few questions:

  1. Is this intended to be the main page for GEPs? It currently shows up in https://deploy-preview-2640--kubernetes-sigs-gateway-api.netlify.app/geps/, but that's not accessible via navigation.
  2. Why aren't these grouped by stability level like the navigation?
  3. I'm very concerned that this list will grow stale, similar to what already happens with or GEP navigation in mkdocs.yml where it's easy to forget to make a change. Is there any kind of automation you can add to mitigate that?

My idea was to give a ready-to-use table of content that can be used to quickly access GEPs, without going to documentation. I agree that we should add some machinery to automatically generate it. I'll add such machinery.

@robscott
Copy link
Member

robscott commented Dec 8, 2023

@mlavacca One note on any potential automation here, @youngnick is working on adding some additional metadata to GEPs, potentially in a more structured way. It's possible that would make it easier to generate a table of contents like this, you may want to wait for Nick's changes to get in before spending too much time on code to generate this.

@mlavacca
Copy link
Member Author

@mlavacca One note on any potential automation here, @youngnick is working on adding some additional metadata to GEPs, potentially in a more structured way. It's possible that would make it easier to generate a table of contents like this, you may want to wait for Nick's changes to get in before spending too much time on code to generate this.

Sounds good! Is there already any PR out about it?

@robscott
Copy link
Member

@mlavacca do you want to rework this now that GEPs have metadata? (https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-1016/metadata.yaml).

@mlavacca
Copy link
Member Author

@mlavacca do you want to rework this now that GEPs have metadata? (https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-1016/metadata.yaml).

Yep, I'll revamp this PR soon. Thanks for the heads up @robscott

@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 23, 2024
@youngnick
Copy link
Contributor

Ping @mlavacca, not sure what you want to do with this PR for now?

@mlavacca
Copy link
Member Author

I have no cycles to work on this at the moment, let's close it for now. In case we can re-open the PR in the future.

@mlavacca mlavacca closed this May 29, 2024
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) lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants