Automation Enhancements Tracker

[keldian]

Essentials

• Include more managed-variables-section generated locations:

  • reference/modules/
  • saltbox/backup/backup.md
  • saltbox/backup/backup2.md

• Support granular managed-variable opt-out input

  • Option A: role documentation front-matter
    • per-section opt-outs
    • per-variable opt-outs

• Support per-variable override examples input. Possible locations:

  • Front-matter
  • Separate template files

• Add a managed-variables-section for global defaults (inventories/group_vars/all.yml) in a page to be determined.

Nice-to-haves

• Support role metadata input in front-matter or role files, such as:

  • Project description
  • Button links
  • App category (ex: category: "Media Management Apps > Collector Accessory > Misc")

• Support templated page elements:

  • Standard sections layout
  • page icon generated based on role type (Docker, host daemon, etc.)
  • deployment tag as parsed from the playbook repo
  • SSO middleware indicator.

• On new Sandbox role merge, trigger:

  • Generate app documentation template as sandbox/apps/PARSED_ROLE_NAME.md
  • mkdocs.yml nav update with the new page

• On new Sandbox role documentation merge, trigger:

  • apps/index.md update: generate table row under the app category specified in the designated location, with the new role details.

• Generate app/module nav groupings from playbook repo groupings, pending Playbook Role Categories Saltbox#446 adoption.

• Support arbitrary managed-variable references (would generate the full variable admonition) from anywhere in the docs, to avoid hardcoding them.

• Notify or update the app documentation if the package repo no longer matches the role's.

---

Feedback and more ideas welcome.