geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Erin Mulder (JIRA)" <...@geronimo.apache.org>
Subject [jira] Commented: (GERONIMO-1883) Make sure all documentation is clearly marked as G 1.0 or G 1.1
Date Thu, 27 Apr 2006 03:23:03 GMT
    [ 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


Mime
View raw message