-
Notifications
You must be signed in to change notification settings - Fork 436
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
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mlavacca 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 |
Signed-off-by: Mattia Lavacca <[email protected]>
Thanks @mlavacca! A few questions:
|
+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. |
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. |
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). |
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:
You can:
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. |
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?: