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

Related — Fri, 21 May 2021 03:31:38 +0000

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.

Whamcloud Community JIRA

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