Wednesday, July 7, 2010

GitHub project created

After considering where to host the code I decided that GitHub is a very good option to allow easy participation from any interested members of the community.

I created a repository with two Sphinx projects, one for articles and one for the book. In the future, demonstration source code will be included there as well.

The repository is at If you are among the volunteers that will be writing articles for this blog, I suggest you strongly consider cloning the repository and doing your work there.

At this moment the repository is empty, except for the book outline, but this will be changing soon.

Thursday, July 1, 2010

Tools for the writing process

Now that the ZODB book is on the planning stages and writing will start soon, it's a good time to think about what tools will be used for writing it.

I propose to use Sphinx to generate the documentation. The text will probably be stored in a Subversion repository, which could be, for example. All of the book code will also live in a repository. I'm not opposed to the use of Github or Bitbucket if most people think that's the way to go, but personally I find I can get by with the above mentioned tools.

After we have at least a couple of chapters in a presentable state, the documentation could be automatically generated every day, so we can start to have a (slightly) useful resource well before the book is finished. We might be able to give the book a home like or something.

Right now I'm not sure about whether we should use a wiki or an issue tracker, but it's something that could become useful if more people participate as voluntary reviewers of the book.

Well, this is how I see the writing process at the moment. Am I missing something? Do you have any ideas or suggestions? I'm willing to consider other options if that would get more people participating in the process.