chore(docs): geps README.md created
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
[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.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
Thanks @mlavacca! A few questions:
- 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.
- Why aren't these grouped by stability level like the navigation?
- I'm very concerned that this list will grow stale, similar to what already happens with or GEP navigation in
mkdocs.ymlwhere it's easy to forget to make a change. Is there any kind of automation you can add to mitigate that?
+1 For this type of file, it is best to allow it to be automatically generated
Yeah, I agree that a TOC like this should be autogenerated. Great idea though.
Thanks @mlavacca! A few questions:
- 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.
- Why aren't these grouped by stability level like the navigation?
- I'm very concerned that this list will grow stale, similar to what already happens with or GEP navigation in
mkdocs.ymlwhere 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.
@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 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?
@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 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
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/staleis applied - After 30d of inactivity since
lifecycle/stalewas applied,lifecycle/rottenis applied - After 30d of inactivity since
lifecycle/rottenwas 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
Ping @mlavacca, not sure what you want to do with this PR for now?
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.