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

Wed Sep 6 19:05:53 UTC 2023
Amy Marrich <amy at redhat.com>

Thanks so much for your work on this and the further clarification! I
really like the layout and the acknowledgement  that things that are
currently working where they are do not need to be changed:)

Amy

*Amy Marrich*

She/Her/Hers

Principal Technical Marketing Manager - Cloud Platforms

Red Hat, Inc <https://www.redhat.com/>

amy at redhat.com

Mobile: 954-818-0514

Slack:  amarrich

IRC: spotz
<https://www.redhat.com/>


On Wed, Sep 6, 2023 at 10:28 AM Fabian Arrotin <arrfab at centos.org> wrote:

> On 06/09/2023 17:04, Aleksandra Fedorova wrote:
> > On 9/6/23 16:48, Fabian Arrotin wrote:
> >> On 06/09/2023 15:47, 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://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.
> >>
> >> These ones (SIGs docs) already exist and are all rendered via mkdocs
> >> (from various git repositories) and so already under
> >> https://sigs.centos.org so no need to change the existing (and
> >> working) workflow
> >>   :-)
> >
> > Yes, I forgot to say it explicitly:
> >
> > I do not propose to put all docs into one repository. Or even to use the
> > same tooling. Existing guides should stay where the are.
> >
> > The idea is that we should have a defined hierarchy and a path how to
> > get to the SIG Guide from the top page on docs.centos.org. And it is
> > perfectly fine if following that path you use an external link and land
> > on a different site built by a different tool.
> >
> > So the *link* to the SIG Guide will be in the Project Documentation
> > section on doc.centos.org.
> >
> > Same for other parts of the documentation:
> >
>
> Ah ! makes sense .. and yes, huge +1 to have finally docs.centos.org the
> main entry point even if itself would either host docs or have pointers
> to other docs :-)
>
> --
> Fabian Arrotin
> The CentOS Project | https://www.centos.org
> gpg key: 17F3B7A1 | @arrfab[@fosstodon.org]
>
> _______________________________________________
> CentOS-devel mailing list
> CentOS-devel at centos.org
> https://lists.centos.org/mailman/listinfo/centos-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.centos.org/pipermail/centos-devel/attachments/20230906/d8744954/attachment-0001.html>