Details
-
Improvement
-
Resolution: Fixed
-
Critical
-
None
-
None
Description
For both SEO and giving external navigation to users, we really need IDs on sections in the DITA markup. This is a major chore, but one that pays big dividends.
Without this:
1) Search Engines cannot link users directly to major sections of the documentation, like "Configuring Logging". Search engines use anchors to render direct links to sections for users. See https://www.searchenginepeople.com/blog/anchor-links.html for one writeup on this.
2) Users like myself cannot link deeply into a document when referring to it in an email, a forums post, etc. This makes for a poor UX. The user has to click and then scroll around.
I know an issue was filed for this long ago. It was discussed as a need in the 4.0 docs, then again in the 4.5 docs. It appears to have been closed without fixing it.
I added some ids at one point as an example, though the generated IDs have some extra dita junk as can be seen in this screenshot: