[jbossts-issues] [JBoss JIRA] (JBTM-1955) Review ALL documentation

[Paul Robinson (JIRA)]

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

Paul Robinson commented on JBTM-1955:
-------------------------------------

There seems to be quite a bit of commented out text in the XTS guides. I think we should remove all this, as it is available in VCS if we need to get it back, and is providing clutter ATM. This is something best fixed in one go over the whole doc set.
                
> Review ALL documentation
> ------------------------
>
>                 Key: JBTM-1955
>                 URL: https://issues.jboss.org/browse/JBTM-1955
>             Project: JBoss Transaction Manager
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: Documentation
>            Reporter: Paul Robinson
>            Assignee: Tom Jenkinson
>             Fix For: 5.0.0.Final
>
>
> I think we need to read through all the documentation looking for:
> 1. Out of date stuff. For example, references to file locations in AS versions prior to AS7.
> 2. Irrelevant stuff. For example: XTS documents the theory of heuristics, despite having no support for them in the current protocols or implementation.
> 3. Incorrect stuff. No examples, but there could be some errors.
> 4. Missing stuff. Most likely for new features, not yet documented.
> For 1. in particular, we should search across the entire documentation for other occurrences of the same issue, once found. For example, if a reference to bin/run.sh is found, then grep over all the other docs for other occurrences.
> I think we should divide up the docs between multiple people so as to not over-burden a single individual with what is likely to be a tedious task.

--
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