DrupalCon Prague Documentation Sprint

You are viewing a wiki page. You are welcome to join the group and then edit it. Be bold!

28 contributers who took up tasks in 38 issues both at the sprint and working remotely, 32 inital patches and at least one contributer who had his first patch committed to Drupal 8 - that's just the figures from the Documentation Sprint at DrupalCon Prague.

What made it work?

  • A clear, but restricted list of tasks. We worked on one meta-issue Updating or creating hook_help texts. The tasks were varied - from reviewing existing texs and changing all links to the new routing format to complete rewrites but had core skills in common. My explanations were, therefore, not only relevant to one person at a time, and contributors could help each other. Once somebody had finished a task, they could move on to a similar one.
  • Working from the meta-issue - a list of all 60 core modules whose hook_help texts need checking, updating, writing or re-writing - meant that there was a lot to choose from without getting lost in the full documentation issue queue.
  • Some good resources: the meta issue; the standard help text as an example of how text should be written and coded; the section about thenew link format; the excellent help pages on drupal.org on how to create patches and interdiffs. All these - old school - listed on a flipchart made them directly accessible to everybody who joined us in the sprint room.
  • Drupal mentoring: Cathy (YesCT) had organized an amazing team of mentors to help new contributors find appropriate tasks and get them set up with a development environment. Previously organisers felt that the documentation table became the place where people would drift who are not sure what they can contribute or how to get started. (I was one of these lost souls at the first sprint I attended myself...) This time nobody who joined us looked lost. Instead everybody was motivated and ready to go.
  • The mentoring task list: I added some of the tasks into the task list for mentors to give out to new contributors. All of them were taken up during the sprint, or even before that.

And now?

Most issues still need review and possibly more work before they can be committed - a task that should be done sooner than later to keep the momentum.
But judging from the flury of activity in my list of issues: That's already happening.
And last but not least: A big thank you to every body who participated and made this possible!


Great Work!

jhodgdon's picture

The sprint was VERY successful -- great work everyone, and of course a big thanks to ifrik, your fearless organizer!

We can still use some help reviewing. If you made a patch in the sprint, you are definitely qualified to review other people's patches. Just go back to the meta-issue and look for issues that show up in yellow "needs review" status. Although... that display is not always going to be up-to-date, so you can try searching for issues with hook_help in the title/text in Needs Review status.

Things to look for in reviews:
- Proofreading: Good grammar, clear writing, correct punctuation and spelling, etc.
- Standards: Follows our standard help template, including correct URL syntax (see links above)
- Function: Apply the patch and test all the links manually to see if they go to the right place, and make sure the formatting looks OK
- Accuracy: read the help text vs. trying out what it tells you to do and make sure it's correct, and that page titles, field labels, tab labels, etc. that you see on the screen match what is in the help text.

If you review a patch for any or all of the above, add a comment to the issue telling what you checked. If you checked all 4 and it looks good, set the status to "reviewed and tested by the community".


Maybe I'll add this to the mentoring task list. :)

Already in task list

jhodgdon's picture

It looks like the mentoring task list already has this pretty much, so what I did instead is replace the review list in the meta-issue with this updated list (which I think is clearer). I also filed issues for a few remaining modules that didn't have issues.

There's still more work to be done, but everyone at DrupalCon did a great deal of it -- let's keep up the momentum! Anyone going to a regional conference who participated in the DrupalCon sprint -- you're in a great position to show others how to contribute!

Next round: Drupal Camp Vienna

ifrik's picture

I'll continue to work on at the Drupal Camp, Sunday 24 November: http://2013.drupalcamp.at/sprints

Site builder and Documentation WG member