You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by "Jessica Tomechak (JIRA)" <ji...@apache.org> on 2012/10/11 00:13:03 UTC
[jira] [Created] (CLOUDSTACK-313) Fix cross references throughout
documentation
Jessica Tomechak created CLOUDSTACK-313:
-------------------------------------------
Summary: Fix cross references throughout documentation
Key: CLOUDSTACK-313
URL: https://issues.apache.org/jira/browse/CLOUDSTACK-313
Project: CloudStack
Issue Type: Improvement
Components: Doc
Affects Versions: 4.0.0
Reporter: Jessica Tomechak
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?
--
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
[jira] [Assigned] (CLOUDSTACK-313) Fix cross references throughout
documentation
Posted by "Joe Brockmeier (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CLOUDSTACK-313?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Joe Brockmeier reassigned CLOUDSTACK-313:
-----------------------------------------
Assignee: Joe Brockmeier
> Fix cross references throughout documentation
> ---------------------------------------------
>
> Key: CLOUDSTACK-313
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-313
> Project: CloudStack
> Issue Type: Improvement
> 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?
--
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
[jira] [Commented] (CLOUDSTACK-313) Fix cross references throughout
documentation
Posted by "Jessica Tomechak (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CLOUDSTACK-313?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13487375#comment-13487375 ]
Jessica Tomechak commented on CLOUDSTACK-313:
---------------------------------------------
See also CLOUDSTACK-427.
> Fix cross references throughout documentation
> ---------------------------------------------
>
> Key: CLOUDSTACK-313
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-313
> Project: CloudStack
> Issue Type: Improvement
> Components: Doc
> Affects Versions: 4.0.0
> Reporter: Jessica Tomechak
> 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?
--
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