[LUDOC-394] Use proper names for sections in the manual

• Type: Improvement
• Resolution: Fixed
• Priority: Minor
• Fix Version/s: Lustre 2.14.0 Manual
• Labels: easy
• Assignee: Lustre Manual Triage
• Reporter: Andreas Dilger

Description

Currently, a large number of sections are named with auto-generated section references like dbdoclet.50438199_14978 that have no meaning. Unfortunately, these section references appear in the HTML manual as the relative URL, like http://doc.lustre.org/lustre_manual.xhtml#dbdoclet.50438199_14978

It would be better to give these section references a proper name, like dbdoclet.deactivating_mdt_ost (as is done in patch https://review.whamcloud.com/30864 "LUDOC-305 maintenance: handling full/failed OSTs" in this specific case), but across the whole manual.

Changing these references is relatively straight forward:

• search for dbdoclet.* (or in a few cases section_*)
• for any reference that does not have a descriptive name
  • make up a new name
  • search the rest of the files for the old name
  • replace the old name with the new name

This could be done in a number of smaller patches, so that the whole thing doesn't break if any other patch lands to the manual. While the manual isn't a hotbed of activity, it will probably take too long to do this manually than can be accomplished in a single sitting, and it cannot be done automatically, so better to break it up into smaller chunks.

Issue Links

• is related to: LUDOC-456 Update the xml ids throughout the manual

Comments

[Gerrit Updater]

Andreas Dilger ([e-mail]) merged in patch https://review.whamcloud.com/43434/
Subject: LUDOC-394 manual: Add meaningful ref names under ConfiguringStorage.xml
Project: doc/manual
Branch: master
Current Patch Set:
Commit: 92e62ce738a711ebd970af5796d86ae7aa2b2208

[Gerrit Updater]

Andreas Dilger ([e-mail]) merged in patch https://review.whamcloud.com/43433/
Subject: LUDOC-394 manual: Add meaningful ref names under SettingLustreProperties.xml
Project: doc/manual
Branch: master
Current Patch Set:
Commit: bd982bd1df39cbb11f04b2c595586847a619d614

[Gerrit Updater]

Andreas Dilger ([e-mail]) merged in patch https://review.whamcloud.com/43432/
Subject: LUDOC-394 manual: Add meaningful ref names under ManagingLNet.xml
Project: doc/manual
Branch: master
Current Patch Set:
Commit: 0a76dfe8389def72316b7488f4db7a23c17d1d50

[Gerrit Updater]

Andreas Dilger ([e-mail]) merged in patch https://review.whamcloud.com/43438/
Subject: LUDOC-394 manual: Add meaningful ref names under BenchmarkingTests.xml
Project: doc/manual
Branch: master
Current Patch Set:
Commit: a0c9ca7dce40b8ad2d85ca4cd239134ba1bd4621

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43438
Subject: LUDOC-394 manual: Add meaningful ref names under BenchmarkingTests.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: aae3e9de93c6bf577bccb3af59ee2dd69e2086c2

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43437
Subject: LUDOC-394 manual: Add meaningful ref names under UserUtilities.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: c176291b0a59932cd01d0457fea624bd6b9cb7e5

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43436
Subject: LUDOC-394 manual: Add meaningful ref names under ManagingFileSystemIO.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: 2889e406e34bb6f381ea91be8a0b67b1f2052622

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43435
Subject: LUDOC-394 manual: Add meaningful ref names under LustreMonitoring.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: cffc4cb60d137a3f74c5b4dcb4345b1a3ffa1ebb

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43434
Subject: LUDOC-394 manual: Add meaningful ref names under ConfiguringStorage.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: d59646cdc000fbc247414b98d932193d3466ec5f

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43433
Subject: LUDOC-394 manual: Add meaningful ref names under SettingLustreProperties.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: 2c1f88c59862c1fa3f634af2912861e09257e481

[Gerrit Updater]

Arshad Hussain ([e-mail]) uploaded a new patch: https://review.whamcloud.com/43432
Subject: LUDOC-394 manual: Add meaningful ref names under ManagingLNet.xml
Project: doc/manual
Branch: master
Current Patch Set: 1
Commit: 11c28e513d9402f76d0fab417c6096a2e2b967ba