Skip to content

Update documentation content for EL 8/9/10 and current tooling #501

Description

@silug

Follow-up to #498, which modernized this repo's build tooling and CI. The documentation content still largely describes the CentOS 6/7/8- and Puppet 4/5/6-era world and needs an editorial pass.

Current state of the RST sources:

  • No mentions of AlmaLinux or Rocky Linux anywhere in docs/, even though supported platforms are now EL (RHEL, AlmaLinux, Rocky Linux, Oracle Linux) 8/9/10
  • ~45 references to EL6 and ~70 to EL7/CentOS 7/RHEL 7 across guides (excluding historical changelogs, which should stay as-is)
  • ~50 references to Puppet 4/5/6 (version-specific instructions, upgrade notes, etc.); these should reflect current Puppet/OpenVox 8+
  • Affected areas include (non-exhaustive):
    • docs/getting_started_guide/ — ISO installation instructions
    • docs/user_guide/ — client management, RPM lists
    • docs/HOWTO/ — IPA clients, NFS, TPM, ENC setup, SIMP release RPM usage
    • docs/security_conop/ — SCAP scan instructions and report templates
    • docs/contributors_guide/ — release procedures and pre-release checklists (also predate the current GitHub-Actions-based release process)
    • docs/FAQ/, docs/glossary.rst

Related context worth reflecting where appropriate:

  • The Puppet → OpenVox migration
  • compliance_engine replacing compliance_markup as the compliance Hiera backend
  • SIMP modules being replaced with community (Vox Pupuli / puppetlabs) modules where possible

Suggested approach: tackle one guide at a time (getting started → user guide → HOWTOs → contributors guide), leaving the historical changelogs untouched. The PR Tests workflow added in #498 builds the HTML docs on every PR, so content changes are now CI-checked.

🤖 Generated with Claude Code

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions