First check in

[Sylvain Hellegouarch]

Hi people,

I have just made the first doc project check in to SVN. Please update your copy
of cherrypy and grab the doc tree.

Now some points to notice :

* I have included the docporject DTD and XSL directories, which makes it easier
to build the doc. Since we won't modify those, you'll have to download them
only once.

* There is a build.sh script (thanks to verbosus) in the docs directory, simply
run it from there. You do need xsltproc from xsmlsoft.org. Or you need to adapt
the script for your own environment. It might be neat to have a script for using
Java tools as well.

Look at the xml directory, you will find the complete tree as splitted files.
verbosus suggested to join them into a few files only (per chapter). I don't
know if this is better. I would like your feeling on it.

Have fun

- Sylvain





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

[Sylvain Hellegouarch]

Ok, it seems that people would rather have the docs directory as a sibling of
the cherrypy one. So I'll move it up one level tonight.

- Sylvain

Selon Sylvain Hellegouarch <s...@defuze.org>:

[mikerobi]

I noticed there is a sessions.xml and a sessionsystem.xml, i started
working on sessions.xml (probly check something in soon).

Not sure if is me, my system or the current state of the docs, but the
only thing I managed to generate was an index.htm which just contained
<?xml version="1.0"?>
and a plain text toc with lots of whitespace.

I don't think we should keep all of the dockbook templates in our svn
tree. It could be really annoying when someone checks in a new
version. When I do a "svn status" i want to see actually changes to
CherryPy, and and not hundreds of docbook files.

:)

Mike

[Steve Howe]

Hello mikerobi,

That's why I told in the first place I suggested a separate doc
repository...

Anyway, Sylvian and the others, I'm sorry I can't be helping as much as
I would like to in the docs: I've been real busy lately.

--
Best regards,
Steve mailto:ho...@carcass.dhs.org

[Remi Delon]

Well, that's one way of looking at it :) ...
But the reason I put the docs there (underneath the "cherrypy"
directory) is because I wanted the docs to stay very close to the code
and to follow the same workflow.
This way, when somebody creates a new branch, this forces them to create
a branch for the docs as well, and hopefully they'll update the docs in
their branch to reflect the changes in the code.
The idea is that for each branch, each tag and for the trunk, the docs
should be in sync with that version of the code ...

I believe that docs are just as important as code and I believe they
should be tied to each other, which is why I used that approach.

Remi.