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

Wed Sep 6 13:57:49 UTC 2023
Patrick Riehecky <riehecky at fnal.gov>

On Wed, 2023-09-06 at 15:47 +0200, Aleksandra Fedorova wrote:
> Hi, folks,
> 
> I was playing with the ways to organize the CentOS Documentation site
> and came up with the following proposal:
> 
> https://urldefense.proofpoint.com/v2/url?u=https-3A__hackmd.io_-40bookwar_centos-2Ddocs-2Dlayout&d=DwICAg&c=gRgGjJ3BkIsb5y6s49QqsA&r=OAMtP0DWou0nlXG7Kmxo2enjXJfwb1DXS9fwcaESuTE&m=0PgBUx5nfN4daWVydpBBK3-Jz5riNkYMnH2ISioaTzo4P7zh1NaIi3NDyaDs3bC0&s=yxcB80ISHIfy95NJ3-JwTThsV3lerjj88lF_sFkUrOc&e=
>  
> 

Awesome!


> 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://urldefense.proofpoint.com/v2/url?u=https-3A__sigs.centos.org_g
> uide_&d=DwICAg&c=gRgGjJ3BkIsb5y6s49QqsA&r=OAMtP0DWou0nlXG7Kmxo2enjXJf
> wb1DXS9fwcaESuTE&m=0PgBUx5nfN4daWVydpBBK3-
> Jz5riNkYMnH2ISioaTzo4P7zh1NaIi3NDyaDs3bC0&s=AMs-BexBbhfm2hQZtl0d-
> F8nOeJ4UvMlDWIlofoPVWI&e= ) 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.
>