Let's start...

[Sylvain Hellegouarch]

Hi folks,

OK, it seems (from IRC discussions) that the proposed Tree (DocProject page on
the wiki) is good enough to start. We will certainly slightly modify it while
writing the doc, but not that much.

I still need to write a documentation guidelines for contributors.

Now we need :

* Main contributors (who will be strongly involved in the process). They should
only be a few, having a really good understandaing of CherryPy
* Contributors for specific and limited areas, people who can't get involved
too much (lack of time for instance) but who would like to help
* Syntax reviewers (checking grammar, tenses, integrity in the style accross
different sections, etc.)
* Semmantic reviewers (checking the overall meaning of each entry)

Anyone?

- Sylvain



----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.

[Lukas Linhart]

Hi,

E-mail Sylvain Hellegouarch ze dne Sun 12. of June 2005 23:22:
> Hi folks,
> Anyone?

Well, I'd like to help. However:
1) I don't heave very deep understanding for cherrypy.
2) My English isn't that good.
3) Leak of time could also be.

However, I understeand docbook and I'd like to help completing docs...so if
there will be something for me, shoot.

> - Sylvain

Regards,

--

Lukas "Almad" Linhart

[:: http://www.Include.cz/ ::]
[:: Including Your wishes ::]
[:: PGP/GNUPg key: http://download.almad.net/pubkey.asc ::]

[Peter Hunt]

I'll help. Tell me what you want me to do.

[Jos Yule]

Sylvain Hellegouarch wrote:
> * Syntax reviewers (checking grammar, tenses, integrity in the style accross
> different sections, etc.)

- I'm in, tho i'd not want to be the only one doing this - i'm not
really a great editor, which is what this position really is.

> * Semmantic reviewers (checking the overall meaning of each entry)

- I'm in.

j


--
jos yule
Digital Hyakugei

mailto:j...@theorganization.net
http://www.theorganization.net

jabber:hyak...@jabber.org
msn:hyak...@hotmail.com
yahoo:digital_hyakugei
aim:josyule
icq:295196397

[Remi Delon]

> * Syntax reviewers (checking grammar, tenses, integrity in the style accross
> different sections, etc.)
> * Semmantic reviewers (checking the overall meaning of each entry)

I noticed that with the Wiki people tend to fix spelling mistakes if
they see one.
So with the new documentation system we should include a small line at
the bottom on each page explaining what to do if someone notices a
mistake on a page (ie: add a ticket in Trac). This way each reader is a
potential proofreader :-)

[Sylvain Hellegouarch]

True.

But adding a ticket for each mistake might be quite overwhelming but I
don't see any other system to keep track of thoses issues.

- Sylvain

Remi Delon a écrit :

[Dave Warnock]

Remi,

> I noticed that with the Wiki people tend to fix spelling mistakes if
> they see one.
> So with the new documentation system we should include a small line at
> the bottom on each page explaining what to do if someone notices a
> mistake on a page (ie: add a ticket in Trac). This way each reader is a
> potential proofreader :-)

Can we allow people, who are able/willing, to email patches to the list.

Dave

[Remi Delon]

Yeah, I guess that would be an easier alternative for people who might
be put off by the "add a ticket" concept ...

[Sylvain Hellegouarch]

Please read the end of the page and tell me what is missing (many things I'm
sure) :

http://www.cherrypy.org/wiki/DocProject

- Sylvain

Selon Remi Delon <re...@cherrypy.org>:

[Peter Hunt]

As a practicing native English speaker, I'll volunteer to be editor in
general, if you'd like.

[Sylvain Hellegouarch]

Cool.

You're in then :)

- Sylvain

Peter Hunt a écrit :