gateway-api icon indicating copy to clipboard operation
gateway-api copied to clipboard

chore(docs): geps README.md created

Open mlavacca opened this issue 2 years ago • 11 comments

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

mlavacca avatar Dec 04 '23 09:12 mlavacca

[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 avatar Dec 04 '23 09:12 k8s-ci-robot

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?

robscott avatar Dec 04 '23 18:12 robscott

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

tao12345666333 avatar Dec 05 '23 00:12 tao12345666333

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

youngnick avatar Dec 05 '23 08:12 youngnick

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.

mlavacca avatar Dec 05 '23 12:12 mlavacca

@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.

robscott avatar Dec 08 '23 01:12 robscott

@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 avatar Dec 11 '23 10:12 mlavacca

@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).

robscott avatar Feb 22 '24 23:02 robscott

@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

mlavacca avatar Feb 23 '24 13:02 mlavacca

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-triage-robot avatar May 23 '24 14:05 k8s-triage-robot

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

youngnick avatar May 24 '24 05:05 youngnick

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 avatar May 29 '24 09:05 mlavacca