[Buildbot-devel] buildbot tutorial

[Thomas Vander Stichele]

Hi all,

I've started writing some buildbot tutorials.

I have two sections completed and wanted to open them up for wider
feedback.  If you have some time, please take a look at
http://thomas.apestaart.org/download/tmp/buildbot/html/index.html

Before I continue I want to see what people think and what they would
like to see from tutorials like this, in case that feedback might cause
me to structurally change the way I'm writing now.

Some things I'm thinking myself at the moment:
- I've written the docs against the latest release and its sample
config.  Like Dustin I think that it makes sense to tweak the default
config to go along with the tutorial (for example, make allowForce
default to True there so that the first run already gets to a useful
point).  For now I'm not doing that yet because that would make the
tutorial not work against the latest release.

- I find the first experience important, which is why the firstrun part
is short, simple, and handholding.  I strongly believe that if someone
out there is looking at a tool to do automatic building, they will give
every project maybe 5 or 10 minutes of their time and continue with the
most promising (at least, that's how I tend to do it).  The more
convincing a project is in those first 5 minutes the better.  So that's
my aim for the first section.

- I also try to start with enough handholding, clearly stating all the
commands that need to be typed, the output that is expected,
screenshots, ... and gradually take off the training wheels as the
tutorial progresses.  I guess I did so because that's how I like things
to be, but I'm not an expert at writing docs.

Anyway, feedback is welcome.  I'll wait for some feedback from you all
before moving on to other tutorials.

Thanks
Thomas

-- 
all I want is happiness
happiness
if you find it share it
with the rest of us
--
GStreamer - bringing multimedia to your desktop
http://gstreamer.freedesktop.org/