#1700 Custom container image to serve SIG's docs?
Closed: Ticket moved to Gitlab tracker by arrfab. Opened by pingou.

Hey!

The Automotive SIG would like to version its documentation and for this, the simplest is to use the mike project.
However, to use mike properly one has to use mike serve to serve the doc instead of the mkdocs server that we're currently using.

How easy/complex would it be to allow SIG to build against specific container images instead of the default one?


Metadata Update from @arrfab:
- Issue tagged with: doc

we don't even use mkdocs serve as we just build doc as html output and that its then synced and exposed as static files through httpd process.
Also , using different kind of containers would make it harder for all SIGs, as it's now all consolidated under https://docs.centos.org, so using one single process (and our container)
Adding a plugin there would be easier but is there something with that plugin that would make it harder to just build the output ?

Also tagging @shaunm and @dcavalca (from Docs SIG) to discuss this (and btw, some discussion around that question was also started on centos-docs matrix channel

https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/ should eventually have some pointers but wondering if that would work with the monorepo plugin that consolidates all docs under docs.centos.org (but it would eventually still work for https://sigs.centos.org/automotive/

Could you tell/show me how the docs are built then? The Containerfile I've linked to seems to run mkdocs serve, not build. How are the html files generated then?

https://docs.centos.org/infra-docs/apps/docs/#centos-documentation-websites (doc for all) has a pointer to ansible role/task for it

From default var, we use build to build the doc and then copy/expose consolidated docs
Also, there are two different things for sigs.centos.org and docs.centos.org
I know that @shaunm wanted to completely kill/decommission sigs.centos.org at one point (it's not under Infra ) so btw, I think it would be better to discuss that in the Docs tracker and not the infra one ?

Due to centos infra tracker migration (https://lists.centos.org/hyperkitty/list/devel@lists.centos.org/thread/V3ZLBYFHMWSZFXOVGVU7R6P2X6ELGY5V/), this ticket is now closed but you can find corresponding ticket open at
https://gitlab.com/CentOS/infra/tracker/-/issues/1700
Metadata for this ticket is imported in new gitlab tracker but not ownership, so feel free to visit migrated ticket to subscribe and get status update.

Metadata Update from @arrfab:
- Issue close_status updated to: Ticket moved to Gitlab tracker
- Issue status updated to: Closed (was: Open)

Log in to comment on this ticket.

Metadata