#458 Location to host mkdocs-based docs for a SIG
Closed: Fixed 10 months ago by pingou. Opened 11 months ago by pingou.

The automotive SIG would like to host mkdocs-based documentation available somewhere. A little bit like the CentOS infra doc currently available at: https://docs.infra.centos.org/

Discussing with @arrfab about this few days ago, he indicated that we could create something like sig.centos.org/<sig_name> and re-use the infrastructure built for the infra-docs to make it available to SIGs.

While the location where this documentation will be hosted is still being defined, we figured we should make this request earlier so that the infrastructure can be prepared.


Metadata Update from @humaton:
- Issue priority set to: Waiting on Assignee (was: Needs Review)
- Issue tagged with: low-trouble, medium-gain

11 months ago

Metadata Update from @arrfab:
- Issue priority set to: Needs Review (was: Waiting on Assignee)
- Issue tagged with: centos-common-infra, feature-request

11 months ago

Metadata Update from @zlopez:
- Issue priority set to: Waiting on Assignee (was: Needs Review)

11 months ago

@pingou I can have something quickly available but was wondering about idea around sig.centos.org or sigs.centos.org as entry point (as it would be shared for all SIGs)
So sigs.c.o would sound "logic" to me and then under we'd have (for example) sigs.centos.org/automotive (where your doc would land).
Opinions ?

@arrfab either works for me :)

Sorry for the late reply, I had completely missed your comment :(

@pingou : have something already in place, that I'd be happy to test with you (automotive SIG) and so then extend to all SIGs.
For that , I'd need a simple git url/origin that would be checked by the tool, and so a very basic one ready to be used by mkdocs would help , and see if workflow would work great.
At the infra and releng side, that will be just adding that in ansible inventory list (for sig name, git origin and description) and it will be rolled out easily.

Let me know when you have at least a skeleton for mkdocs (just mkdocs.yml and docs/index.md would do it as a start : https://www.mkdocs.org/getting-started/)

Metadata Update from @arrfab:
- Issue assigned to arrfab

11 months ago

Metadata Update from @arrfab:
- Issue priority set to: Waiting on Reporter (was: Waiting on Assignee)

11 months ago

Please onboard the Hyperscale SIG on this as well, using https://pagure.io/centos-sig-hyperscale/sig for our docs repo. Thanks!

All live and announced too (https://lists.centos.org/pipermail/centos-devel/2021-September/077351.html)
@pingou as it's there, can you create (where you want , or we can also host it on git.centos.org if you prefer) a git repo that contains just what's needed to build simple skeleton and it will be added to ansible inventory and automatically pushed.
We'll then be able to close this ticket

@pingou as it's there, can you create (where you want , or we can also host it on git.centos.org if you prefer) a git repo that contains just what's needed to build simple skeleton and it will be added to ansible inventory and automatically pushed.

Thanks! Working on getting us that git repo :)

Pushed to git and ansible applied it but just remember that we use the specific material for mkdocs/squidfunk container to build the doc so just verify that it works for you :

https://sigs.centos.org/automotive/

You can always test locally with our own doc and same container before pushing to your git repo (see README.md )

Just asking for feedback and then closing

We managed to get our first changes landing and rebuilt.

Thanks for your help!

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

10 months ago

Login to comment on this ticket.

Metadata
Boards 1