#543 Rewrite SIGGuide for SIGs users and host it under https://sigs.centos.org/guide
Closed: Fixed with Explanation 2 years ago by arrfab. Opened 2 years ago by arrfab.

Back in the days, there was a SIG Guide hosted on the wiki (https://wiki.centos.org/SIGGuide) but it's not easy to find nor maintain so we'd like to just convert existing doc and publish that in its own git repository, that will ease SIG collaboration to make the user doc relevant, and would contain up2date and verified documentation.
As we have already such process for SIGs, we'd just follow same process and host it under https://sigs.centos.org (probably under /guide) and we'd then be able to use this new doc and replace wiki page with pointer


Metadata Update from @arrfab:
- Issue assigned to arrfab

2 years ago

Metadata Update from @arrfab:
- Issue tagged with: cbs, centos-common-infra, doc, high-gain, low-trouble

2 years ago

Nice to see that this documentation is planned to be updated!
It was really not that helpful for me and even unnecessarily confusing sometimes.

Back when starting I wrote down some of the CBS specific stuff in the kmods SIG's documentation: https://sigs.centos.org/kmods/internal/cbs/
It seems the Hyperscale SIG also has some documentation concerning CBS and building packages in general as well: https://sigs.centos.org/hyperscale/internal/building/

These resources might be helpful when updating the SIGGuide, especially as these are written by people who had low experience with the CentOS infrastructure.

Feel free to crib anything you'd like from the Hyperscale docs if it's helpful.

It's WIP and when basically I have a some (free) time but I already pushed some content : https://sigs.centos.org/guide

I'll just import remaining doc from wiki and then we can just have a link to new place and as it's hosted on git.centos.org, accept PR and/or issues when SIG users consider that something should be clarified and so directly documented/added with a simple "git commit && git push" operation

Let me know if you see how we should structure this, all comments are welcome :)

Let's consider this task done as workflow is working and content migrated from wiki (and so now PR are welcome to enhance the existing doc)

Metadata Update from @arrfab:
- Issue close_status updated to: Fixed with Explanation
- Issue status updated to: Closed (was: Open)

2 years ago

Log in to comment on this ticket.

Metadata
Boards 2
CBS Status: Backlog