You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cocoon.apache.org by H....@MI.unimaas.nl on 2004/04/08 20:56:26 UTC

Documentation TOC started

Guys (and girls),

I want to structure all the documentation about Cocoon in the Wiki and the
xdocs. I've started small by setting up a Wiki page
http://wiki.cocoondev.org/Wiki.jsp?page=Cocoon215TOC which should become a
Table of Contents into documentation geared to Cocoon 2.1.5 and future
versions.
At first I want to fill this page with links to existing Wiki and xdoc
pages, after that missing pages should be added and outdated pages updated
or rewritten.

The first draft of this TOC is far from complete, so I'd like you all to
take a quick look at the wiki page and add missing items and sections.

Thanks.

Bye, Helma

Re: Documentation TOC started

Posted by David Crossley <cr...@apache.org>.
Helma.vanderLinden wrote:
> Guys (and girls),
> 
> I want to structure all the documentation about Cocoon in the Wiki and the
> xdocs. I've started small by setting up a Wiki page
> http://wiki.cocoondev.org/Wiki.jsp?page=Cocoon215TOC which should become a
> Table of Contents into documentation geared to Cocoon 2.1.5 and future
> versions.

Good idea and i admire your enthusiasm. 

You will see my additions to that page were i tried to ensure
that it only links to local Cocoon documentation. Already i see
that people are not heeding that, and linking off to all sorts of
remote stuff. It may end up just being a jump page to everything.

> At first I want to fill this page with links to existing Wiki and xdoc
> pages, after that missing pages should be added and outdated pages updated
> or rewritten.
> 
> The first draft of this TOC is far from complete, so I'd like you all to
> take a quick look at the wiki page and add missing items and sections.

Please also scan the dev@ and the old docs@ archives.
This TOC topic has been discussed and commenced many times.

I think that such pages will need very clear intentions and
monitoring to keep on track.

--David


Re: Documentation TOC started

Posted by Tony Collen <co...@umn.edu>.
H.vanderLinden@MI.unimaas.nl wrote:

> Guys (and girls),
> 
> I want to structure all the documentation about Cocoon in the Wiki and the
> xdocs. I've started small by setting up a Wiki page
> http://wiki.cocoondev.org/Wiki.jsp?page=Cocoon215TOC which should become a
> Table of Contents into documentation geared to Cocoon 2.1.5 and future
> versions.
> At first I want to fill this page with links to existing Wiki and xdoc
> pages, after that missing pages should be added and outdated pages updated
> or rewritten.
> 
> The first draft of this TOC is far from complete, so I'd like you all to
> take a quick look at the wiki page and add missing items and sections.
> 

Awesome, Helma!

I was rolling around the idea of how to reorganize and rewrite the docs 
the other day... I appreciate you taking the time to do this.

One thing I was thinking about:  Should we try to move the existing 
"real" docs to the Wiki, to let us revise them easier?  I think we would 
need something to convert the docs format to Wiki and back easily. 
Chaperon should allow us to go from Wiki -> Docs, but it's a matter of 
having the time to actually do it.

> Thanks.
> 
> Bye, Helma

Thoughts?

Tony