[JBoss JIRA] (JBTM-2281) Merge the documentation manuals together
by Gytis Trikleris (JIRA)
[ https://issues.jboss.org/browse/JBTM-2281?page=com.atlassian.jira.plugin.... ]
Gytis Trikleris updated JBTM-2281:
----------------------------------
Status: Pull Request Sent (was: Open)
Git Pull Request: https://github.com/jbosstm/documentation/pull/28
> Merge the documentation manuals together
> ----------------------------------------
>
> Key: JBTM-2281
> URL: https://issues.jboss.org/browse/JBTM-2281
> Project: JBoss Transaction Manager
> Issue Type: Feature Request
> Components: Documentation
> Reporter: Tom Jenkinson
> Assignee: Gytis Trikleris
>
> The documentation for our project is available here:
> Narayana Documentation 5.0.2.Final - JBoss Community
>
> As you can see it consists of several downloads including multiple books, links to various JavaDocs and some IDL files. Personally I think it might be easier to locate documentation entries if there is a single document to consult and a single JavaDoc link. I consulted our users whether anyone would object to us producing a single document and single JavaDoc set and received no objection. I am also thinking of no longer publishing the IDL as separate files as these are always tagged and available in our repo.
> One way or another we need to make it clear in the docs what is in product and what is in project. Its not quite so important for our community users to know this but when translating docs into product manuals it is crucial. Currently this is done because everything under https://github.com/jbosstm/documentation/tree/master/docs is product related and things one level up are various community projects. An obvious way to merge the docs is merge everything under docs and then everything under ../* except docs - i.e. 2 manuals
--
This message was sent by Atlassian JIRA
(v6.3.8#6338)
10 years, 1 month
[JBoss JIRA] (JBTM-2281) Merge the documentation manuals together
by Gytis Trikleris (JIRA)
[ https://issues.jboss.org/browse/JBTM-2281?page=com.atlassian.jira.plugin.... ]
Gytis Trikleris updated JBTM-2281:
----------------------------------
Status: Resolved (was: Pull Request Sent)
Resolution: Done
> Merge the documentation manuals together
> ----------------------------------------
>
> Key: JBTM-2281
> URL: https://issues.jboss.org/browse/JBTM-2281
> Project: JBoss Transaction Manager
> Issue Type: Feature Request
> Components: Documentation
> Reporter: Tom Jenkinson
> Assignee: Gytis Trikleris
>
> The documentation for our project is available here:
> Narayana Documentation 5.0.2.Final - JBoss Community
>
> As you can see it consists of several downloads including multiple books, links to various JavaDocs and some IDL files. Personally I think it might be easier to locate documentation entries if there is a single document to consult and a single JavaDoc link. I consulted our users whether anyone would object to us producing a single document and single JavaDoc set and received no objection. I am also thinking of no longer publishing the IDL as separate files as these are always tagged and available in our repo.
> One way or another we need to make it clear in the docs what is in product and what is in project. Its not quite so important for our community users to know this but when translating docs into product manuals it is crucial. Currently this is done because everything under https://github.com/jbosstm/documentation/tree/master/docs is product related and things one level up are various community projects. An obvious way to merge the docs is merge everything under docs and then everything under ../* except docs - i.e. 2 manuals
--
This message was sent by Atlassian JIRA
(v6.3.8#6338)
10 years, 1 month
[JBoss JIRA] (JBTM-2292) Update Narayana release script
by Gytis Trikleris (JIRA)
[ https://issues.jboss.org/browse/JBTM-2292?page=com.atlassian.jira.plugin.... ]
Gytis Trikleris updated JBTM-2292:
----------------------------------
Description:
Following changes are needed for Narayana release script:
* Documentation was completely changed by JBTM-2281, thus links have to be changed
* New API bundle was introduced with JBTM-2286. It should be used instead of separate JTA, JTS, XTS, RTS archives
* Upload download links to the new web page via github
* Replace extracted versions of documentations on the web page
* Update narayana release process doc
* Update webpage update readme
was:
Following changes are needed for Narayana release script:
* Documentation was completely changed by JBTM-2281, thus links have to be changed
* New API bundle was introduced with JBTM-2286. It should be used instead of separate JTA, JTS, XTS, RTS archives
* Upload download links to the new web page via github
* Replace extracted versions of documentations on the web page
> Update Narayana release script
> ------------------------------
>
> Key: JBTM-2292
> URL: https://issues.jboss.org/browse/JBTM-2292
> Project: JBoss Transaction Manager
> Issue Type: Task
> Components: Release Process
> Reporter: Gytis Trikleris
> Assignee: Gytis Trikleris
> Fix For: 5.0.4
>
>
> Following changes are needed for Narayana release script:
> * Documentation was completely changed by JBTM-2281, thus links have to be changed
> * New API bundle was introduced with JBTM-2286. It should be used instead of separate JTA, JTS, XTS, RTS archives
> * Upload download links to the new web page via github
> * Replace extracted versions of documentations on the web page
> * Update narayana release process doc
> * Update webpage update readme
--
This message was sent by Atlassian JIRA
(v6.3.8#6338)
10 years, 1 month
[JBoss JIRA] (JBTM-2292) Update Narayana release script
by Gytis Trikleris (JIRA)
Gytis Trikleris created JBTM-2292:
-------------------------------------
Summary: Update Narayana release script
Key: JBTM-2292
URL: https://issues.jboss.org/browse/JBTM-2292
Project: JBoss Transaction Manager
Issue Type: Task
Components: Release Process
Reporter: Gytis Trikleris
Assignee: Gytis Trikleris
Fix For: 5.0.4
Following changes are needed for Narayana release script:
* Documentation was completely changed by JBTM-2281, thus links have to be changed
* New API bundle was introduced with JBTM-2286. It should be used instead of separate JTA, JTS, XTS, RTS archives
* Upload download links to the new web page via github
* Replace extracted versions of documentations on the web page
--
This message was sent by Atlassian JIRA
(v6.3.8#6338)
10 years, 1 month
[JBoss JIRA] (JBTM-2286) Create a zip with all javadocs included
by Gytis Trikleris (JIRA)
[ https://issues.jboss.org/browse/JBTM-2286?page=com.atlassian.jira.plugin.... ]
Gytis Trikleris updated JBTM-2286:
----------------------------------
Status: Resolved (was: Pull Request Sent)
Resolution: Done
> Create a zip with all javadocs included
> ---------------------------------------
>
> Key: JBTM-2286
> URL: https://issues.jboss.org/browse/JBTM-2286
> Project: JBoss Transaction Manager
> Issue Type: Task
> Components: Documentation
> Reporter: Gytis Trikleris
> Assignee: Gytis Trikleris
> Fix For: 5.0.4
>
>
> Currently javadocs are split by component. It would be convenient to produce a single bundle of javadocs of all project as well for ease of publishing on the site.
> What we are proposing is to produce a single Javadoc artifact for the Narayana project which has all the public API stuff (ignoring **/internal/**). Same as what you get with the JSE or JEE javadocs. A single link for users to see all public Narayana javadoc.
> Each component will create its own JavaDocs as normal but a single uber zip would also be produced and this is what would be published on the site.
--
This message was sent by Atlassian JIRA
(v6.3.8#6338)
10 years, 1 month