geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jason Dillon" <ja...@planet57.com>
Subject Re: Geronimo documentation - upcoming look & feel
Date Thu, 11 May 2006 19:45:23 GMT
Just a thought... we may eventually want to have a space per-version
for our documentation.

GDOCS10
GDOCS11
etc...

I think we should not limit ourselves to one space, but use them to
organize documents on a very high-level.

--jason


On 5/11/06, Hernan Cunico <hcunico@gmail.com> wrote:
> I just wanted to show how the doc will potentially look like, just the look & feel.
The content is
> being baked and what is shown there is not the main page, just a tentative TOC under
development for
> the Geronimo v1.1 documentation
>
> Once cwiki is implemented, the main page should be on the Geronimo web site pointing
to the specific
> Geronimo's version and available project's documentation. In plain English it would be
something like:
>
> Documentation page
>         - Apache Geronimo v1.0 - User's guide
>         - Apache Geronimo v1.1 - User's guide
>         - Apache Geronimo - Developer's guide
>         ...
>
> On the draft I sent, I just wanted to highlight the top banner, the removal of user names
and the
> ASL license disclaimer at the bottom of each page, not the actual content. However, this
is a good
> opportunity to refresh the call for volunteers to contribute with the Project's documentation.
>
> Just in case you forgotten ;) , the TOC for Geronimo's v1.1 documentation is available
at the
> following URL:
>
> http://opensource.atlassian.com/confluence/oss/display/GERONIMO/Apache+Geronimo+V1.1+-+Documentation
>
> If anybody is able to contribute with the project's documentation, in any possible way,
please feel
> free to ping me if you have any questions, concerns, suggestions, .... Thanks in advance
!!!
>
> Cheers!
> Hernan
>
>
>
> Matt Hogstrom wrote:
> > Looks good Hernan.  For context, is this the main documentation page ?
> > Perhaps it would make it clearer to call this the "Project User's Guide"
> > so as to avoid confusion between this and other forms of documentation
> > at developerworks, articles, etc.
> >
> > Hernan Cunico wrote:
> >
> >> Hi All,
> >> I just wanted to give you guys a heads up on how the Geronimo's
> >> confluence wiki may look like once
> >> cwiki.apache.org jumps in production.
> >>
> >> Available at the following link is just a single page, static draft
> >> based on what is in the oven for Geronimo v1.1 documentation. The new
> >> confluence wiki will be running a plugin that automatically exports
> >> the new content into HTML format so it can be served as static content
> >> increasing the performance.
> >>
> >> Not only that, the HTML exports can be configured using templates so
> >> we can select the information we want to display, for example removing
> >> the classic "Added by / last edited by" if it turns to be an issue.
> >>
> >> Three key things to pay special attention from the template used are,
> >> obvious banner at the top of the page, user names removed and Apache
> >> license disclaimer at the very bottom of each page.
> >>
> >> http://people.apache.org/~hcunico/cwiki/documentation.html
> >>
> >> Comments, questions, suggestions are welcomed :)
> >>
> >> Cheers!
> >> Hernan
> >>
> >>
> >>
> >>
> >
>

Mime
View raw message