You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geronimo.apache.org by "Aaron Mulder (JIRA)" <de...@geronimo.apache.org> on 2006/04/21 17:31:05 UTC

[jira] Created: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Make sure all documentation is clearly marked as G 1.0 or G 1.1
---------------------------------------------------------------

         Key: GERONIMO-1883
         URL: http://issues.apache.org/jira/browse/GERONIMO-1883
     Project: Geronimo
        Type: Bug
    Security: public (Regular issues) 
  Components: documentation  
    Versions: 1.0    
    Reporter: Aaron Mulder
    Priority: Critical
     Fix For: 1.1


As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Hernan Cunico (JIRA)" <de...@geronimo.apache.org>.
    [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=comments#action_12376281 ] 

Hernan Cunico commented on GERONIMO-1883:
-----------------------------------------

- Missing from the previous comment -

Current 1.0 articles containing working examples will have their respective version in 1.1

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Hernan Cunico (JIRA)" <de...@geronimo.apache.org>.
    [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=comments#action_12376263 ] 

Hernan Cunico commented on GERONIMO-1883:
-----------------------------------------

I am working on a structure for the Geronimo v1.1 documentation update. This structure is in confluence, here is the URL:

http://opensource.atlassian.com/confluence/oss/display/GERONIMO/Apache+Geronimo+V1.1+-+Documentation+Draft

The idea is not to duplicate what we have in Geronimo v1.0 documentation but to rather focus in the "What's new - XYZ"

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Erin Mulder (JIRA)" <de...@geronimo.apache.org>.
    [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=comments#action_12376625 ] 

Erin Mulder commented on GERONIMO-1883:
---------------------------------------

I'm not sure how everything is set up right now (it looks like there's only one space for all of Geronimo).  However, it might be nice to just create a new  Confluence documentation space for each meaningful release.  In this scenario, when it was time to stop writing about 1.0 and start writing about 1.1, somebody would create a new "Geronimo 1.1 Documentation" space and copy over all of the pages from 1.0 (using Confluence's import/export features).  Each page could then be individually updated without losing the original 1.0 documentation.  A custom Confluence skin could provide navigation between documentation versions, highlighting the current version number so that you'd always know what you were looking at.

This strategy would mesh well with the way code tags/branches are handled, while providing great documentation experiences to users of both 1.0 and 1.1.

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Resolved: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Hernan Cunico (JIRA)" <de...@geronimo.apache.org>.
     [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=all ]
     
Hernan Cunico resolved GERONIMO-1883:
-------------------------------------

    Resolution: Fixed

All the documentation has been reorganized and migrated over the new wiki
cwiki.apache.org

>From now on there should be one new space for each new major release of Geronimo

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Hernan Cunico (JIRA)" <de...@geronimo.apache.org>.
    [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=comments#action_12376280 ] 

Hernan Cunico commented on GERONIMO-1883:
-----------------------------------------

Not everything in the documentation is depending on the deployment plans.

I think we should focus first on creating a thorough list identifying all the changes, major and minor and a description of each change. A summarized version of this list should be later included in the RELEASE-NOTES-1.1.txt

A prioritized "Summary of changes" should be the foundation for building the Geronimo v1.1 documentation. The info described in this  list will allow us to better structure the v1.1 documentation.

We should later discuss on weather to include or not those documents that have not changed from 1.0 to 1.1

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Aaron Mulder (JIRA)" <de...@geronimo.apache.org>.
    [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=comments#action_12376265 ] 

Aaron Mulder commented on GERONIMO-1883:
----------------------------------------

First of all, I think the plan for 1.1 is a mistake.  Since every deployment plan must change, I think we should copy every 1.0 page and make a 1.1 version of it with the correct information (alternately, update them all in place and switch the header from saying 1.0 to saying 1.1 as you do it).  If someone is looking for help on how to deploy a web app, it's no good to have a page full of incorrect syntax and another page somewhere else saying "everywhere you see a configId you should change it like this..."

Regardless of that, I still feel strongly that every 1.0 page should be clearly marked 1.0.  We have to expect that someone looking for information on, say, web apps or EJBs in Geronimo will find their way to the 1.0 documentation page, follow the instructions, and then ask why it doesn't work.  Thanks.


> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Assigned: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1

Posted by "Hernan Cunico (JIRA)" <de...@geronimo.apache.org>.
     [ http://issues.apache.org/jira/browse/GERONIMO-1883?page=all ]

Hernan Cunico reassigned GERONIMO-1883:
---------------------------------------

    Assign To: Hernan Cunico

> Make sure all documentation is clearly marked as G 1.0 or G 1.1
> ---------------------------------------------------------------
>
>          Key: GERONIMO-1883
>          URL: http://issues.apache.org/jira/browse/GERONIMO-1883
>      Project: Geronimo
>         Type: Bug
>     Security: public(Regular issues) 
>   Components: documentation
>     Versions: 1.0
>     Reporter: Aaron Mulder
>     Assignee: Hernan Cunico
>     Priority: Critical
>      Fix For: 1.1

>
> As we roll out 1.1, with different deployment plan syntax, it'll be extremely import that *all* documentation clearly states (e.g. in big bold text at the top) which Geronimo version it applies to.  We can go ahead and mark all the 1.0 content as 1.0 now, and just update the marker as the content itself is updated to 1.1.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira