This is a good proposal Luciano. I like the idea of "branching" the
docs. Just as the Sun JDKs provide versioned docs from the 1.0 days to
the current 1.6 days, I too would like to see versioned Tuscany docs.
In addition to versioned wiki spaces, we might want to think about
versioned public pages. Right now there is an export plugin that moves
the wiki pages to the external site html pages. Perhaps we need to
branch the tuscany web site so there would be a "latest" html snap shot
at http://tuscany.apache.org and earlier "versioned" html snap shots,
perhaps at http://tuscany.apache.org/1.4, etc.
Much of our site shows up here [1] in the svn repos, perhaps we need to
add versions under this point in the repos.
[1] http://svn.apache.org/repos/asf/tuscany/site/
Luciano Resende wrote:
As we discussed in [1], please take a look at a proposed structure to
use as our Java SCA Documentation for both 1.x and 2.x development
streams.
The idea is to have two separate wikis, where we would have the latest
documentation for each of the development streams, and during the
releases we would export a snapshot of the wiki space and make it
available either online in our website, or as a doc distribution. The
concept of "guide books" would allow us to group related contents, and
the new navigation outline in the left gives the user a better user
experience, and is built automatically by Confluence based on the page
name and hierarchy. Please take a look at the initial contents in the
2.x Documentation space [3] and it's PDF version that we could use in
a release [4] and provide feedback.
If people are OK, I can spend some time documenting some "usage
guidelines" to make sure the generated outline give us the right
navigation benefits and exporting does not contain unwanted navigation
markup; and then we could start migrating more of the contents from
our website to the new wikis.
Thoughts ?
[1] http://www.mail-archive.com/[email protected]/msg04344.html
[2] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx1x/Index
[3] http://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/Index
[4]
http://people.apache.org/~lresende/tuscany/doc/TUSCANYxDOCx2x-20090203-16_21_57.pdf
--
Thanks, Dan Becker
