[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-313) Copyrights and versions stated in documents do not align with the release version of the doc & the JBT release version

Thu Apr 18 02:42:53 EDT 2013

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

Michelle Murray edited comment on TOOLSDOC-313 at 4/18/13 2:42 AM:
-------------------------------------------------------------------

1. If nothing has been changed in a doc then the copyright date does not change. Nothing has changed for the majority of the docs.

2. I am aware of the issue with the version numbers being wrong for community docs. This has arisen because each doc is in a different git repo and it is a huge hassle to fork 12+ different repos, make one tiny change in each repo, push all the changes back, wait for each dev in charge of their repo to pull the change in and then run the jenkins job again. It raises questions about how docs are stored in repos.

Currently, most of the docs have not had version numbers updated for 4.0.0. The docs are all in the 4.0.x branches. They need the version number changed to 4.0.0, be built/pushed with jenkins jbosstools-docs_40. I will start this painful task this/next week.

None of the docs were changed for 4.0.1. The 4.0.0 docs are all applicable for 4.0.1. This needs to be stated somewhere on the website and the docs should not be duplicated.

3. Yes, please change the 4.0.1Final page to read "JBoss Tools Guides - 4.0.1.Final". I'm not sure if automation is possible for this.

      was (Author: mmurray):
    1. If nothing has been changed in a doc then the copyright date does not change. Nothing has changed for the majority of the docs.

2. I am aware of the issue with the version numbers being wrong for community docs. This has arisen because each doc is in a different git repo and it is a huge hassle to fork 12+ different repos, make one tiny change in each repo, push all the changes back, wait for each dev in charge of their repo to pull the change in and then run the jenkins job again. It raises questions about how docs are stored in repos.

Currently, most of the docs have not had version numbers updated for 4.0.0. The docs are all in the 4.0.x branches. They need the version number changed to 4.0.0, be built/pushed with jenkins jbosstools-docs_40. I will start this painful task this/next week.

None of the docs were changed for 4.0.1. The 4.0.0 docs are all applicable for 4.0.1. This needs to be stated somewhere on the website.

3. Yes, please change the 4.0.1Final page to read "JBoss Tools Guides - 4.0.1.Final". I'm not sure if automation is possible for this.

> Copyrights and versions stated in documents do not align with the release version of the doc & the JBT release version
> ----------------------------------------------------------------------------------------------------------------------
>
>                 Key: TOOLSDOC-313
>                 URL: https://issues.jboss.org/browse/TOOLSDOC-313
>             Project: Documentation for JBoss Tools and Developer Studio
>          Issue Type: Bug
>      Security Level: Public(Everyone can see) 
>          Components: General documentation issues
>    Affects Versions: 4.0.1, 4.1.0
>            Reporter: Nick Boldt
>            Assignee: Michelle Murray
>
> Some places where docs' copyright dates and stated versions do not align with the version of the doc:
> {code:title=http://docs.jboss.org/tools/4.0.1.Final/en/GettingStartedGuide/html/index.html}
> Version: 4.0.0
> Copyright © 2012 JBoss by Red Hat
> {code}
> {code:title=http://docs.jboss.org/tools/4.0.1.Final/en/beginners_guide/html/index.html}
> Version: 3.3.0.M5
> Copyright © 2011 JBoss by Red Hat
> {code}
> {code:title=http://docs.jboss.org/tools/4.0.1.Final/en/as/html/index.html}
> Version: 3.3.0.M5
> Copyright © 2007, 2008, 2009, 2010 JBoss by Red Hat
> {code}
> {code:title=http://docs.jboss.org/tools/4.0.1.Final/en/jmx_ref_guide/html/index.html}
> Copyright © 2007, 2008, 2009, 2010, 2011 JBoss by Red Hat
> {code}
> And yes, this is still a problem in trunk:
> {code:title=http://docs.jboss.org/tools/nightly/trunk/en/beginners_guide/html/index.html}
> Version: 3.3.0.M5
> Copyright © 2011 JBoss by Red Hat
> {code}
> {code:title=http://docs.jboss.org/tools/nightly/trunk/en/forge_reference/html/index.html}
> Version: 3.3.1
> Copyright © 2012 JBoss by Red Hat
> {code}

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