Details

    • Improvement
    • Resolution: Unresolved
    • Minor
    • None
    • None
    • None
    • 9223372036854775807

    Description

      The xml:id for each section should have a meaningful name instead of docbook.<numeric_string>. This change makes the URLs contain the meaningful section ID which is indicative of the section of the manual to which it links. It is also nice when editing an xml file to know what section the link is referring to without having to search for the random docbook numeric string to find out.

      This ticket should capture all the refactoring needed to update the sections defined in each XML file (one file per patch as a general rule of thumb) and the associated pages that are linking to those section IDs.

      An example of a patch already landed for this type of work: https://review.whamcloud.com/#/c/36015/

      Attachments

        Issue Links

          Activity

            [LUDOC-456] Update the xml ids throughout the manual

            Joseph Gmitter (jgmitter@whamcloud.com) merged in patch https://review.whamcloud.com/36047/
            Subject: LUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml
            Project: doc/manual
            Branch: master
            Current Patch Set:
            Commit: 329486c28c051ab4b99a4c7990fade6d972550dd

            gerrit Gerrit Updater added a comment - Joseph Gmitter (jgmitter@whamcloud.com) merged in patch https://review.whamcloud.com/36047/ Subject: LUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml Project: doc/manual Branch: master Current Patch Set: Commit: 329486c28c051ab4b99a4c7990fade6d972550dd

            Joseph Gmitter (jgmitter@whamcloud.com) uploaded a new patch: https://review.whamcloud.com/36047
            Subject: LUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml
            Project: doc/manual
            Branch: master
            Current Patch Set: 1
            Commit: 38033a751340e54256d4ae0ab602f947065de953

            gerrit Gerrit Updater added a comment - Joseph Gmitter (jgmitter@whamcloud.com) uploaded a new patch: https://review.whamcloud.com/36047 Subject: LUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml Project: doc/manual Branch: master Current Patch Set: 1 Commit: 38033a751340e54256d4ae0ab602f947065de953

            People

              LM-Triage Lustre Manual Triage
              jgmitter Joseph Gmitter (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: