#1629 Duplicate SIG docs site with inconsistencies
Closed: Wrong tracker a month ago by arrfab. Opened a month ago by amcleod.

Hi, I noticed today that the automotive SIG docs site https://sigs.centos.org/automotive (built from https://gitlab.com/CentOS/automotive/sig-docs) is duplicated on the https://docs.centos.org/ domain at https://docs.centos.org/automotive-sig-documentation. This copy of the docs is using git submodules to collect many different documentation repos into one place (docs.centos.org). I think this is a worthwhile goal, but it has some issues:

  • Inconsistent rendering. Due to inclusion of an mkdocs extension in automotive/sig-docs, the content built from that repo renders correctly, but certain elements (code blocks) are broken when rendered on the docs.centos.org domain.
  • For SEO and user findability/navigation, it's confusing to have the same content in two places.
  • Missing functionality. Any repo-specific additions (such as the feedback button, HTML/JS overrides etc.) are not reflected in the docs.centos.org copy without intervention.

I suggest/request that it would be better all around to have just one URL for the automotive/sig-docs content. Likely the solution is to include a link in the docs.centos.org mkdocs.yml, rather than including the mkdocs.yml from the sig-docs repo submodule. This would mean that docs.centos.org stays the same, but if a user clicks 'Automotive' on that page, they are directed to sigs.centos.org/automotive as the single place where that documentation is served. If this sounds like a suitable plan, I'm happy to make the update.

Many thanks,
Alex


Hi @amcleod .
Even if I'm not disagreeing with you on the content of your issue, I still think that it would better to report it to correct tracker (from the Docs SIG, maintaining docs.centos.org content)

Per their own doc (https://docs.centos.org/centos-docs-sig/communication/channels/), it would be better to report that on https://gitlab.com/CentOS/docs/sig/-/issues

Metadata Update from @arrfab:
- Issue assigned to arrfab

a month ago

Metadata Update from @arrfab:
- Issue priority set to: Waiting on External (was: Needs Review)
- Issue tagged with: doc, low-trouble

a month ago

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

a month ago

Log in to comment on this ticket.

Metadata