kubernetes / kubernetes/website

Programatically sync feature gate status from k/k to documentation

Open
#50,992 20 comments 2 reactions 1 assignee Claimed by @royalsflush View on GitHub
needs-triage
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

It is a lot of manual effort and error prone to check feature gate stage changes and ensure they are well reflected in the documentation. Feature owners sometimes forget, we sometimes have typos, and there is a non-zero chance for inaccuracies to slip into the website.

Without touching prior feature gates, we should be able to sync the feature gates emitted from k/k's [versioned_feature_list.yaml](https://github.com/kubernetes/kubernetes/blob/master/test/compatibility_lifecycle/reference/versioned_feature_list.yaml) to the [website feature gate status](https://github.com/kubernetes/website/tree/main/content/en/docs/reference/command-line-tools-reference/feature-gates) directory.

Is this something we can leverage scripting for? I see we have a python script `update-imported-docs.py` that does something similar with OpenAPI. Can we add a new script somewhere to mirror the gates in `versioned_feature_list.yaml` in a release (or master) branch into the feature gate directory?

Would https://github.com/kubernetes/kubernetes/issues/128241 be a prerequisite or can we directory use the yaml file?

/cc @lmktfy @tengqm

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.