Uploaded image for project: 'CPE Infrastructure'
  1. CPE Infrastructure
  2. CPE-3463

Duplicate SIG docs site with inconsistencies

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • Testable

      https://pagure.io/centos-infra/issue/1629

      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

              farrotin@redhat.com Fabian Arrotin
              cle_bot CLE bot
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: