Details
Minor Description
Hyperlinks in the documentation need some work.
(1) In "See section x", often "section x" is not clickable.
(2) Some xref and ulink tags contain links to improper destinations, such as docs.cloudstack.org.
(3) Other links need to be conditionalized so they can change depending on which book is being built.
Conditionalization technique isn't clear. For example, Concepts is included in every book. A link from the Concepts chapter to an Install Guide section might need to have different text depending on whether you are currently reading the Install Guide or some other Guide. The link text would also depend on the output format, PDF vs. HTML. To take the same example again, if you are viewing the Concepts html page, it doesn't matter whether you are in the Admin Guide or Install Guide; in both cases, the destination of the link would be a single HTML page in the Install Guide. In contrast, a PDF link should go to an anchor inside the PDF document if possible. If not, should it be static text, like "See NFS Shares in the Installation Guide"? Or should it go to a URL on the doc website? Should we assume people reading PDFs prefer not to hit the website?
Release Planning:
Dev List discussion: unknown
Functional Spec: N/A
QA: will be done when the docs are reviewed for the release
Attachments
1.
|
QA - need to verify cross references fixed by this improvement |
|
Closed | Unassigned |