Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-1850

Wrong subsection headings names in "jump to section" menu on docs.redhat.com

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • Logging 5.8, Logging 6.0, Logging 6.1, Logging 6.2, Logging 6.3
    • Logging
    • False
    • Hide

      None

      Show
      None
    • False

      When navigating to https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/logging/ one is presented with the content page and two menu:

      • Left menu is listing the chapters
      • Right menu is named "Jump to section" and is listing all the subsection headers of all the chapters in the left menu

      There are mistakes/repetitions of subsection headers in the right menu, which create confusion in the navigation and almost voids the advantage of having the "Jump to section" menu. Here are the mistakes listed for each chapter:

      Chapter 1. Logging 6.2
      second and third subsection headers are both named "Logging 6.2", while they should be named respectively: "Release notes" and "About logging 6.2"

      Chapter 2. Logging 6.1
      second and third subsection headers are both named "Logging 6.1", while they should be named respectively: "Release notes" and "About logging 6.1"

      Chapter 3. Logging 6.0
      third subsection header is named "Logging 6.0", while it should be named "About logging 6.0"

      Chapter 4. Logging 5.8
      first subsection header is named "Logging 5.8", while it should be named "Release notes"

      I noticed that the header naming is correct in the topic map, e.g.:
      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/_topic_maps/_topic_map.yml#L3011
      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/_topic_maps/_topic_map.yml#L3013

      but that is not reflected in the actual headers used by the docs.redhat.com portal. Probably the topic map was only used in the discontinued docs.openshift.com portal.

      What needs to be changed is the actual title used by each subsection:

      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/observability/logging/logging-6.2/log6x-release-notes-6.2.adoc?plain=1#L4
      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/observability/logging/logging-6.2/log6x-about-6.2.adoc?plain=1#L4

      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/observability/logging/logging-6.1/log6x-release-notes-6.1.adoc?plain=1#L4
      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/observability/logging/logging-6.1/log6x-about-6.1.adoc?plain=1#L4

      https://github.com/openshift/openshift-docs/blob/enterprise-4.17/observability/logging/logging-6.0/log6x-about.adoc?plain=1#L4

      https://github.com/openshift/openshift-docs/blob/main/observability/logging/logging_release_notes/logging-5-8-release-notes.adoc?plain=1#L4

      Since the right menu contains the subsections for all the chapters, and these subsection headers often have the same name, it would be even better to have the following structure for the headers names in the right menu:

      Logging 6.2 support
      Logging 6.2 Release notes
      About logging 6.2
      ...

      Logging 6.1 support
      Logging 6.1 Release notes
      About logging 6.1
      ...

      Logging 6.0 support
      Logging 6.0 Release notes
      About logging 6.0
      ...

      Logging 5.8 Release notes
      Installing Logging 5.8

              amehenda@redhat.com Ashwin Mehendale
              fminafra-redhat Francesco Minafra
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: