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

Consider generating spec docs from a machine-readable description #1469

Closed
bgilbert opened this issue Sep 22, 2022 · 0 comments · Fixed by #1588
Closed

Consider generating spec docs from a machine-readable description #1469

bgilbert opened this issue Sep 22, 2022 · 0 comments · Fixed by #1588

Comments

@bgilbert
Copy link
Contributor

It could be useful to have a machine-readable analog to the spec docs: either one per spec version, or perhaps a single file that specifies the versions in which each config field is available. This might help with coreos/butane#390, and might also help reduce maintenance burden.

The ideal place to store this information is in the JSON Schema, but that might require an infeasible amount of tooling. Also, the docs' understanding of which fields are required doesn't always match the schema, since the docs describe higher-level semantics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants