Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically derive spec docs from Ignition spec docs #390

Open
bgilbert opened this issue Sep 22, 2022 · 0 comments
Open

Automatically derive spec docs from Ignition spec docs #390

bgilbert opened this issue Sep 22, 2022 · 0 comments
Labels
enhancement New feature or request jira

Comments

@bgilbert
Copy link
Contributor

While the Butane docs intentionally diverge from the Ignition docs at many points, they also share significant material. When we update the vendored Ignition to a newer version, we often forget to (manually) sync the spec docs, causing a slow divergence over time. Occasionally this causes spec fields not to be documented.

Consider automatically generating the Butane specs from the Ignition ones. We'd need a way to specify a set of rules for adding and removing fields relative to the Ignition schema, for adjusting the wording of field descriptions, and for converting camel case fields to snake case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request jira
Projects
None yet
Development

No branches or pull requests

2 participants