GUADEC registration is open

Online GUADEC 2014 registration is now open at https://www.guadec.org/register/

There is a limited number of rooms available which can be booked on registering and lunch vouchers can also be purchased.

The venue has changed to a more central location with better access to the city centre. It now looks like:

Strasbourg hotHohenlohe a.JPG
Strasbourg hotHohenlohe a” by Ralph HammannOwn work. Licensed under <a title="Creative Commons Attribution-Share Alike 3.0
” href=”http://creativecommons.org/licenses/by-sa/3.0″>CC BY-SA 3.0 via Wikimedia Commons.

Cincinnati, home of goetta breakfast sausage

Dave, Petr, Mike, Jim, Shaun and I are now half way through Open Help in Cincinnati, OH, USA. This is the  fourth Open Help and I’m happy to say that the documentation team has made it to all four so far (and also to Writing Open Source, the predecessor to Open Help).

IRL

We have heard a number of fascinating presentations so far, generally themed around engaging contributors and creating a community. Eric Shepherd talked to us about breaking down barriers to contribution and fostering the Mozilla community. Rich Bowen shared his wisdom on helping newcomers with documentation. Shaun McCance has been building a community around Clifton Market in real life, which has proven to be an interesting challenge.

Dave and I took the opportunity to talk about how the documentation team does outreach, the challenges faced with interships and barriers to contributions.

Tomorrow, the documentation team are going to start on the sprints where we will be working on the system administrator guide.


Open Help Conference & Sprints

Running a documentation training session

Last Friday, the documentation team ran a training session for 25 odd newcomers to open source contribution. While the silence in response to “How many of you have ever contributed to any open source project?” was deafening, it was refreshing to see so many people turn up to try something new and the enthusiasm was overwhelming.

Many of the attendees came with GNOME in a virtual machine or installed, as we asked them to make sure that they had a recent version or gnome-continuous in a VM, which is essential for documentation. While most of the attendees were running Unity or GNOME, some were running Windows.

The tools which the newcomers had to have were a text editor, git and yelp. yelp-tools was also desirable, but although we covered yelp-tools briefly, we didn’t get around to using it.

The newcomers started by finding the GNOME documentation team space on the wiki and navigating to the tasks page. While they would normally have been expected to pick the link to easy bugs from there, for the training session, we picked some bugs that had especially low barriers to entry. These bugs did not generally require one to build applications, had especially good descriptions and were relatively clear.

When the newcomers reached Bugzilla and picked a bug, the next step was to figure out which project the help was in (gnome-user-docs or one of the applications, this is listed under “Product” in the bug details), then find the product in git. One of the issues which we came across was that the search for git repositories is a little bit unreliable. For example, searching for “gnome user docs” gives no results, instead of showing gnome-user-docs. While I would generally start a browser search for the repository name on the page, almost all the newcomers went straight for the search field in the page.

Next up, the newcomers had to understand the bug, and in some cases find which page it was on. While the majority of user docs are in /help/C, it was very confusing that gnome-user-docs are in /gnome-help/C. And why not help/en? C is intended to be the source docs, and it’s only convention that they happen to be in English in GNOME. There’s no reason for them to be in English other than that more people are able to write in English and translate from English.

Files were edited, changes were made. Various text editors were used, such as vim, vi, emacs, nano and gedit, to name a few. Files were not always saved.

At this point, it became clear that some parts of the help on how to write documentation could be improved. Eventually, everything was figured out.

As most of the attendees had never used git before, they had to set it up.

Lastly, the patch creation and attaching patches to bugzilla were simple last steps to finish off over an hour of work.

Untitled

The experience has reinforced the idea that the biggest step to first contributions is setting up the working environment and figuring out how all of our tools work. This is surprisingly difficult for many people who want to contribute and learn how we work.

We had around 25 attendees, some of whom worked in pairs. Unfortunately, it’s currently not possible to have multiple authors for a commit, so some of the newcomers who worked in pairs will not be listed as authors in git. In total, there were around 20 odd bugs that were looked at. André, Dave and Aleksander helped out at the event, but it was still difficult to effectively help so many people. Under ideal circumstances, I would prefer to have an absolute maximum of 4 individuals per mentor and preferably around 3 or so capable attendees per mentor.


Documentation team at GNOME.Asia

The documentation team will be at GNOME.Asia this weekend and we are running a session for newcomers today, and there’s also an introduction to GNOME 3 development session which is being run by David King. The GNOME.Asia team have been really great at helping us arrange and set up the training sessions, so they definitely deserve a big thank you!

Training session at GNOME.Asia

There will be a re-run of the documentation talk during the conference, on Saturday, for those who are not able to make the pre-conference event and I will be happy to help give people a hand with making their first contribution to documentation!

I’ve also put together a pretty LaTeX beamer GNOME.Asia theme, which is free to use (and will be available as soon as I can upload it!).


Developer documentation

The 2014 Developer Experience hackfest has just started at the Endocode office in Berlin. It was great of Chris to offer the space to us!.

=BERLiN!

GTK+ datamodels, API docs and hand written docs will be discussed today. The hand written docs will cover the developer documentation which comes from gnome-devel-docs and Ryan‘s HowDoI series on the wiki.

This evening, we are going to join the Berlin Open Source Meetup at the Prater. If you want to talk to us, come and join us!

Tomorrow we will move onto the GTK roadmap, including the new HIG, development tools and developer.gnome.org.