Website: Generate feature gates list from data

Created on 15 Dec 2020  路  3Comments  路  Source: kubernetes/website

This is a Feature Request


What would you like to be added
Track a list of feature gates as, eg, YAML, and generate https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/ from that data.

Why is this needed

  • This improvement lets people update the feature state for a gate with a one line change, eg
    ```diff
    --- feature_gates.yaml 2020-01-21 15:24:34.907668274 +0000
    +++ feature_gates.yaml 2020-03-15 10:39:43.852042785 +0000

@@ -16,6 +16,8 @@
- name: AllowExtTrafficLocalEndpoints
betaFromVersion: v1.4
deprecatedFromVersion: v1.8
+ - name: AnyVolumeDataSource
+ alphaFromVersion: v1.18
- name: APIListChunking
alphaFromVersion: v1.8
betaFromVersion: v1.9

```

  • This change enables future work to:

    • autogenerate the input data

    • improve the feature-state shortcode

  • Combining this with other data could let the Kubernetes project have a single view of new features and deprecations for a release, generating that view automatically.

Comments
/kind feature

kinfeature triagaccepted

Most helpful comment

I love this idea! On compiling major themes for 1.20, I had to go back and forth between k/k PR and k/website PR to see if the changes are in sync. Is this a step towards generating from the actual code itself?

All 3 comments

To clarify something: we need to localize the descriptions for each feature gate, so those descriptions would still be part of the content. The good thing about having this list as data is that we can lint to make sure that each added feature gate has a matching description.

I love this idea! On compiling major themes for 1.20, I had to go back and forth between k/k PR and k/website PR to see if the changes are in sync. Is this a step towards generating from the actual code itself?

/triage accepted

Was this page helpful?
0 / 5 - 0 ratings