Commit Graph

6 Commits

Author SHA1 Message Date
Tim Bannister daecef8292 Render feature gate descriptions automatically
Build a sorted list of feature gates based on the individual files that
describe them.
2023-12-28 14:54:05 +00:00
Dipesh Rawat b1873fc9ea
Replace the existing tables with the shortcode 2023-12-23 19:10:26 +00:00
Dipesh Rawat 27b6d14824
Fix typo in feature gates table 2023-12-22 01:48:20 +00:00
Qiming Teng 41955b102a Fix feature gates for v1.29 2023-12-21 20:20:09 +08:00
Tim Bannister c30baa47f8 Reinstate the MultiCIDRRangeAllocator feature gate
Document MultiCIDRRangeAllocator as a deprecated feature gate.
2023-12-16 13:35:53 +00:00
Tim Bannister d69dc41fe6 Switch to per-file feature gate descriptions
Replace the feature gate descriptions so that there is a Markdown file
for each feature gate.

Use a shortcode to render a feature gate description. If you use the
shortcode, this also validates that any feature gate you reference
has exactly one descriptive text for the current localization.

Localizations can adopt this new approach piecemeal.

Likely benefits:
- when feature gates are removed from Kubernetes, the localization work
  to do won't require any language skills
- merge conflicts are less likely because the list of feature gates
  becomes just a list of names (descriptions are elsewhere, so changes
  that just affect descriptions won't cause a conflict)
- we'll have a machine-readable list of all the feature gates we
  document, and can compare that to other lists if we want to
- we'll gain a place to add metadata about feature gates. For example,
  this lays groundwork for a future change where we record the KEP
  number (if known) for a feature gate, and can render that where it's
  useful.
2023-12-13 17:38:51 +00:00