[jbossts-issues] [JBoss JIRA] (JBTM-2594) Link some doc chapters at higher levels on the project site

[Tom Jenkinson (JIRA)]

    [ https://issues.jboss.org/browse/JBTM-2594?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13144363#comment-13144363 ] 

Tom Jenkinson commented on JBTM-2594:
-------------------------------------

I don't think we link to the specific blacktie docs, just its javadocs - and that is only because they aren't integrated into the main build. I will create a new issue to merge the BlackTie javadocs into the main Narayana ones.

I agree that linking to specific sections of the docs would still be useful from the site. One thing we would need to consider is how to make sure docbook generates links that don't look random (#d0e16062 in your example).



> Link some doc chapters at higher levels on the project site
> -----------------------------------------------------------
>
>                 Key: JBTM-2594
>                 URL: https://issues.jboss.org/browse/JBTM-2594
>             Project: JBoss Transaction Manager
>          Issue Type: Feature Request
>          Components: Documentation
>    Affects Versions: 5.2.11.Final
>            Reporter: Mark Little
>
> On the main Narayana site (http://narayana.io) we call out the higher level components such as JTA, STM, Orb Portability etc. However, on the docs page (http://narayana.io/documentation/index.html), apart from Blacktie the reader needs to load and read through the entire doc (or manually search) for the relevant sections. Maybe link the relevant chapters (such as http://narayana.io/docs/project/index.html#d0e16062) in the docs pages and/or the top level of the site, so someone looking for the JTS or STM docs can click there immediately.



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)