Proposal for the CentOS Documentation layout

Problems to solve

• Wiki is deprecated and relevant content needs to be migrated out of it in some form of Git repo
• SIGs need their own space for documentaion of SIG-specific processes and knowledge
• There are mkdocs and asciidocs-based documentation content
• There are certain User Guides which can be written by or in collaboration with RHEL Documentation teams.

Proposal

Top level has four entries:

User Documentation: everything about installing and administering the CentOS system. Large guides go here, as well as Knowledge Base articles.

Project Documentation: All about processes and policies of the CentOS Project.

SIGs documentation: Documentation subtrees maintained by each Special Interest group on their own.

Wiki(deprecated, read-only): link to a wiki site.

Sublevels can be provided in a form of Antora submodules or can link to separate sites, as with SIG Guide (https://sigs.centos.org/guide/) which uses mkdocs.

---

Detailed view:

CentOS Documentation Home

User Documentation

• Virtualization Guide
• System Administration Guide
• Release Notes: 7, 8, 9, 10..
• Knowledge Base – collection of how-to articles, which are focused on a specific task

Project Documentation

Communication channels

• News - Where to follow project news
  • Announce mailing lists
  • Blog
  • Social networks
• Collaboration - Where to collaborate
  • Mailing lists
  • Discourse
  • Issue trackers
    • Pagure
    • GitLab
    • GitHub
    • Bugzilla
    • Jira
  • IRC
  • Matrix

CentOS Stream Contributor's Guide

Special Interest Groups Guide

• How to create a SIG
• How to join a SIG
• How to request SIG infrastructure

Infrastructure Docs

• Common Infrastructure
• Stream Infrastructure
• SIGs Infrastructure

Governance

• CentOS Board
• Code of Conduct
• Other processes and policies

SIGs Documentation

• Automotive SIG docs
• ISA SIG docs
• Integration SIG docs
• Hyperscale SIG docs
• Promo SIG docs
  …

Wiki(deprecated, read-only)