You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geronimo.apache.org by Hernan Cunico <hc...@gmail.com> on 2006/05/11 17:15:15 UTC
Geronimo documentation - upcoming look & feel
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
Re: Geronimo documentation - upcoming look & feel
Posted by Jason Dillon <ja...@planet57.com>.
I meant more like rearranging things to reduce the space. Anyways not a big deal. Can always tweak it later.
--jason
-----Original Message-----
From: Hernan Cunico <hc...@gmail.com>
Date: Fri, 12 May 2006 10:19:22
To:dev@geronimo.apache.org
Subject: Re: Geronimo documentation - upcoming look & feel
I just used the same banner we have in the web site, we could make it thinner if needed.
As for the bread-crumbs height, I think that's pretty standard. Although I have not fully tested it,
the templates used to automatically export the content to HTML accepts embedded css so we could
potentially customize a lot more.
Cheers!
Hernan
Jason Dillon wrote:
>> On 5/11/06, Hernan Cunico <hc...@gmail.com> 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.
>>
>> ...
>>
>>> http://people.apache.org/~hcunico/cwiki/documentation.html
>>>
>>> Comments, questions, suggestions are welcomed :)
>
>
> Anyway we can figure how to reduce some of the logo/bread-crumbs/
> toolbar height?
>
> --jason
>
Re: Geronimo documentation - upcoming look & feel
Posted by Hernan Cunico <hc...@gmail.com>.
I just used the same banner we have in the web site, we could make it thinner if needed.
As for the bread-crumbs height, I think that's pretty standard. Although I have not fully tested it,
the templates used to automatically export the content to HTML accepts embedded css so we could
potentially customize a lot more.
Cheers!
Hernan
Jason Dillon wrote:
>> On 5/11/06, Hernan Cunico <hc...@gmail.com> 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.
>>
>> ...
>>
>>> http://people.apache.org/~hcunico/cwiki/documentation.html
>>>
>>> Comments, questions, suggestions are welcomed :)
>
>
> Anyway we can figure how to reduce some of the logo/bread-crumbs/
> toolbar height?
>
> --jason
>
Re: Geronimo documentation - upcoming look & feel
Posted by Jason Dillon <ja...@planet57.com>.
> On 5/11/06, Hernan Cunico <hc...@gmail.com> 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.
> ...
>> http://people.apache.org/~hcunico/cwiki/documentation.html
>>
>> Comments, questions, suggestions are welcomed :)
Anyway we can figure how to reduce some of the logo/bread-crumbs/
toolbar height?
--jason
Re: Geronimo documentation - upcoming look & feel
Posted by Hernan Cunico <hc...@gmail.com>.
I agree, it would be a really nice hit if we can include it in the distribution which, BTW, it rises
again the call for volunteers to contribute with the project's documentation.
If anybody is able to contribute with the project's documentation, in any possible way, this is the
time for doing it :) Please feel free to ping me with any questions, concerns, suggestions.
Cheers!
Hernan
Jacek Laskowski wrote:
> On 5/11/06, Hernan Cunico <hc...@gmail.com> 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.
>
> ...
>
>> http://people.apache.org/~hcunico/cwiki/documentation.html
>>
>> Comments, questions, suggestions are welcomed :)
>
>
> Whow, that looks pretty! If it becomes part of our distribution it
> will surely be a major differentiator against other application
> servers, esp. open source ones. I have always liked BEA WebLogic for
> their astonishing documentation online so when people realize we've
> got alike we're winners! Thanks Hernan!
>
>> Hernan
>
>
> Jacek
>
Re: Geronimo documentation - upcoming look & feel
Posted by Jacek Laskowski <ja...@laskowski.net.pl>.
On 5/11/06, Hernan Cunico <hc...@gmail.com> 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.
...
> http://people.apache.org/~hcunico/cwiki/documentation.html
>
> Comments, questions, suggestions are welcomed :)
Whow, that looks pretty! If it becomes part of our distribution it
will surely be a major differentiator against other application
servers, esp. open source ones. I have always liked BEA WebLogic for
their astonishing documentation online so when people realize we've
got alike we're winners! Thanks Hernan!
> Hernan
Jacek
--
Jacek Laskowski
http://www.laskowski.net.pl
Re: Geronimo documentation - upcoming look & feel
Posted by Matt Hogstrom <ma...@hogstrom.org>.
Thanks Hernan for plugging on this.
Hernan Cunico wrote:
> Yup, once we move to cwiki I will reorg the documentation, and along
> comes another call for volunteers to contribute with this effort :)
>
> The plan is, each release doc goes into it's own space, other docs will
> be grouped by relevance into their own separated spaces. The main
> pointers to those spaces will be from the Geronimo web site.
>
> Having individual spaces will give us more flexibility for managing
> them, better structure, reduced footprint for the exports, improved
> performance, etc, overall content will be more organized.
>
> It is funny, on my local confluence installation, I have been working on
> that reorganization for some time now and I called the spaces (the short
> names) in the same way :D
>
> We are working with the infrastructure team to see what's needed to go
> live with cwiki.apache.org
>
> Cheers!
> Hernan
>
> Jason Dillon wrote:
>> 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 <hc...@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
>>> >>
>>> >>
>>> >>
>>> >>
>>> >
>>>
>>
>
>
>
Re: Geronimo documentation - upcoming look & feel
Posted by Hernan Cunico <hc...@gmail.com>.
Yup, once we move to cwiki I will reorg the documentation, and along comes another call for
volunteers to contribute with this effort :)
The plan is, each release doc goes into it's own space, other docs will be grouped by relevance into
their own separated spaces. The main pointers to those spaces will be from the Geronimo web site.
Having individual spaces will give us more flexibility for managing them, better structure, reduced
footprint for the exports, improved performance, etc, overall content will be more organized.
It is funny, on my local confluence installation, I have been working on that reorganization for
some time now and I called the spaces (the short names) in the same way :D
We are working with the infrastructure team to see what's needed to go live with cwiki.apache.org
Cheers!
Hernan
Jason Dillon wrote:
> 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 <hc...@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
>> >>
>> >>
>> >>
>> >>
>> >
>>
>
Re: Geronimo documentation - upcoming look & feel
Posted by Jason Dillon <ja...@planet57.com>.
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 <hc...@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
> >>
> >>
> >>
> >>
> >
>
Re: Geronimo documentation - upcoming look & feel
Posted by Hernan Cunico <hc...@gmail.com>.
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
>>
>>
>>
>>
>
Re: Geronimo documentation - upcoming look & feel
Posted by Matt Hogstrom <ma...@hogstrom.org>.
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
>
>
>
>
Re: Geronimo documentation - upcoming look & feel
Posted by Aaron Mulder <am...@alumni.princeton.edu>.
Looks like it addresses my gripes with the current confluence pages. Thanks!
I also agree with the other comment that it would be ideal to have
separate 1.0 and 1.1 "spaces" -- which is to say, separate
documentation sets. Ultimately I think version N should have
everything that version N-1 had only updated and with a "what changed"
page and covering any new features.
Thanks,
Aaron
On 5/11/06, Hernan Cunico <hc...@gmail.com> 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
>
>