[
https://issues.apache.org/jira/browse/CLOUDSTACK-313?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13591987#comment-13591987
]
ASF subversion and git services commented on CLOUDSTACK-313:
------------------------------------------------------------
Commit a02844b20b6b09b6db5f2482dfc3f6a279101dbd in branch refs/heads/4.0 from
[~jzb]
[ https://git-wip-us.apache.org/repos/asf?p=incubator-cloudstack.git;h=a02844b ]
CLOUDSTACK-313: fixing cross-references in accessing-vms.xml
> Fix cross references throughout documentation
> ---------------------------------------------
>
> Key: CLOUDSTACK-313
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-313
> Project: CloudStack
> Issue Type: Improvement
> Security Level: Public(Anyone can view this level - this is the
> default.)
> Components: Doc
> Affects Versions: 4.0.0
> Reporter: Jessica Tomechak
> Assignee: Joe Brockmeier
> Priority: Minor
> Fix For: 4.1.0
>
>
> 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
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
