[CentOS-devel] Proposal for documentation layout on docs.centos.org

Wed Sep 6 13:47:33 UTC 2023
Aleksandra Fedorova <alpha at bookwar.info>

Hi, folks,

I was playing with the ways to organize the CentOS Documentation site 
and came up with the following proposal:

https://hackmd.io/@bookwar/centos-docs-layout

The link has more details but in short we need three categories of content:

  * User Documentation: everything about installing and administering 
the CentOS system. Large guides go here, as well as small 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.

Note that by SIG docs here I mean documentation written and owned by 
individual special interest groups. The current SIG Guide 
(https://sigs.centos.org/guide/) belongs to the "Project Documentation" 
section in this hierarchy.

Each top-level item is then expanded to more sub-levels.

For many of the items mentioned in the proposal we do not have the 
content written yet. But if we agree on the layout, we can start by 
rearranging existing documents to fit the hierarchy.

Then we will be able to use the proposed map for any new content, which 
we add in the future.

-- 
Aleksandra Fedorova
Matrix: @bookwar:fedora.im
Fediverse: @bookwar at fosstodon.org