27 February 2013

Planning... in Brno.

So, how did the Documentation sprint go? Not bad, not bad at all. I wish I would have been feeling better (I was quite under the weather, I don't know why) - and that I could have been a bit more productive (and that I could have gone for a few more beers with the others), that's all I can complain about.


  • I finally wrote the "generic widget" example for the Python GTK+ tutorial for beginners. I also learned a bit of Cairo in the process.
  • I reviewed (with a precious help of Kat Gerasimova) the above mentioned tutorial as a whole.
  • Last but not least, with Allan Day and Dave King we planned a complete rewriting of the presentation of the developer docs.

The last point is the reason for the title of this post. The idea is to separate the tutorials for beginners (that may be either a 10 minutes tutorial on "how to do something" or a more extensive introduction to a library) and the documentation directed at more experienced programmers. The former would end in a separate area in the website, whereas the latter would be under "tutorials" in the main website. Allan Day has designed a wonderful mock-up:

Developer docs homepage

So, what's next?

My idea is to start by splitting the current Python GTK+ tutorial in two versions. The first one should be a tutorial for beginners, structured as the way the Tutorial for beginners is now: a gradual path through the widgets with some theory; the pages being a gradual building of a nice example, on the model of Taryn Fox's tutorial for JavaScript. The second one should be something for more experienced programmers, structured on the model of the "GTK+ widgets sample code" page: the pages being almost an API, but with a medium-difficulty example to illustrate it.

I would then revise the Guitar Tuner and Image Viewer tutorials to make them a first example of "10 minutes tutorials" (for GStreamer and GTK+, respectively).

And then... I could do the same for the JavaScript tutorials; I am quite new to the language, so I would love some help - but on the other hand I was quite new to Python last year and that helped me a lot in walking in the shoes of the beginner for which the tutorial was intended! And/or I could continue with Python and do something like what we have for GTK+ for some other library (there is a nice Cairo tutorial that could be a great starting point).

So: many plans for the future have come out of this Documentation sprint. Many pleasant meetings, a lot of new ideas, a better understanding of little (but not less relevant!) things (I never knew that there was a difference between the capitalization of the titles in UK and US English - now I know)...

So: a "see you soon" to everyone who was there, a GIGANTIC thank you to our hosts in Brno, especially Florian Nadge, who woke up at 4am to pick me up at the airport on the first day! and that accompanied us almost everywhere.

And, of course: thanks to the GNOME Foundation who sponsored my travel!

GNOME travel sponsorship badge

And... see you soon for GUADEC, Brno!

No comments :

Post a Comment