coreos / coreos/ignition

Automatically derive spec docs from Ignition spec docs

Open
#2,266 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

butane
Dominant language
Go
Stars
974
Forks
296
Avg merge
6d 14h
Merged PRs (30d)
9

Description

Created originally in Butane by @bgilbert: https://github.com/coreos/butane/issues/390


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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Butane issue and comparing the shared Butane and Ignition spec documentation. Define how rules would add or remove fields, adjust descriptions, and convert camel case to snake case; done means the Butane specs can be derived automatically without losing their intentional differences.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.