WIP: Dedicated CentOS Stream Documentation

Adam Samalikrequested to merge
asamalik/centos-project-docs:centos-stream-toplevel into main

Creating a dedicated CentOS Stream section.

This way we can have a place that explains what CentOS Stream is, how it works, and how to contribute to it. All nicely together.

Place in the menu - separate repo?

I would like it to be on the top level in the docs. Right now on the staging instance there's a menu:

  • Project Docs
  • Quick Docs
  • CentOS Stream <-- here
  • SIG guide
  • SIGs
  • Wiki archive

But I can't do that in the same repo here. It feels like it needs to be a separate repo, and then included in the main mkdocs.yaml in the docs.centos.org repo.

I could create a separate repo, and would offer maintaining it. We could put it either here under gitlab/centos/docs or under gitlab/redhat/centos-stream/docs/. What do you think?

Right now I put it at the top just for easy preview locally.

CentOS Stream docs vs. Project Docs

I think the Project Docs should keep sections like:

  • Overview
  • Governance
  • Policy
  • ... and maybe some sections from the current Contributor's Guide

The CentOS Stream docs will have the following sections (all in the MR):

  • About Stream (initial version done)
  • Build Pipeline (initial version done)
  • Release (initial version done)
  • Contributor's Guide (TBD - we'll move and edit content from the existing pages)
  • Report a Bug (initial version done)

I wrote the text all in one go, and haven't edited it much. So it's a starting point we can iterate on!

Merge request reports