Goal
Move every role's variable documentation to a single source of truth: each
role's meta/argument_specs.yml. This gives runtime input validation and
feeds an auto-generated variable table in the role's README.md, rendered with
ansible-docsmith. A
Test Documentation CI workflow fails a pull request if a README drifts from
its spec.
This replaces the hand-maintained variable lists in docs/role-*.md, which
could silently drift from defaults/main.yml.
This is part of #234 and #218
Approach — one PR per role
For each role:
- Add
meta/argument_specs.yml covering every variable in defaults/main.yml.
- Add a
README.md with the docsmith markers + generated variable table:
- Point
README.md, docs/getting-started.md and docs/role-<role>.md at the
new role README.
Shared infrastructure (.docsmith/readme.md.j2, the Test Documentation gate,
and the contributor guide in the main README) landed with the first role.
Roles
Done when
All boxes are checked → this closes #234 and #218.
Goal
Move every role's variable documentation to a single source of truth: each
role's
meta/argument_specs.yml. This gives runtime input validation andfeeds an auto-generated variable table in the role's
README.md, rendered withansible-docsmith. A
Test DocumentationCI workflow fails a pull request if a README drifts fromits spec.
This replaces the hand-maintained variable lists in
docs/role-*.md, whichcould silently drift from
defaults/main.yml.This is part of #234 and #218
Approach — one PR per role
For each role:
meta/argument_specs.ymlcovering every variable indefaults/main.yml.README.mdwith the docsmith markers + generated variable table:README.md,docs/getting-started.mdanddocs/role-<role>.mdat thenew role README.
Shared infrastructure (
.docsmith/readme.md.j2, theTest Documentationgate,and the contributor guide in the main README) landed with the first role.
Roles
elasticstack_*variables)Done when
All boxes are checked → this closes #234 and #218.