Generate spec docs from a YAML source file #1588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👍🏻 Looks cool. The nice diff of fixes is already a win. |
Move all field descriptions to a single YAML file and generate version- specific spec docs from that. Use reflection to walk the config structs for each version and omit fields which don't exist in a particular spec version. We don't do this at a JSON Schema level because e.g. Resource is referenced in multiple places with different semantics and different doc strings. For now, keep the code out of the external API. The plan is to add functionality to support Butane docs generation, at which point internal/doc/generate will move to config/doc. Update the stabilization checklist to remove manual tweaking of spec docs.
Move link URLs inline and fix various small errors. Fixes #1469.
prestist
approved these changes
Mar 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Move all field descriptions to a single YAML file and generate version-specific spec docs from that. Use reflection to walk the config structs for each version and omit fields which don't exist in a particular spec version. Also allow the YAML file to include transformation rules for each field, consisting of a spec version range, a regex, and replacement string.
We don't do this at a JSON Schema level because e.g.
Resourceis referenced in multiple places with different semantics and different doc strings.For now, keep the code out of the external API. The plan is to add functionality to support Butane docs generation (coreos/butane#390), at which point
internal/doc/generatewill move toconfig/doc.Fixes #1469 and various small docs errors.