User Guide sprint at DrupalCon?

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.
jhodgdon's picture

I was looking at the Sprints page for DrupalCon New Orleans and noticed that on the accompanying sign-up spreadsheet, there is not yet a Documentation sprint listed. (Sprints are times at DrupalCon where people get together to work on projects.) I can't complain about this too much, since I will not be at DrupalCon and will also not be available remotely to help out... But we do have quite a few well-defined and doable User Guide project issues that would be perfect tasks for sprinting. Each issue whose title starts with "Content edit" or "Copy edit" in the issue list has a well-defined task and a link to the instructions. Many of them can be completed fairly quickly; some would require a bit more effort.

Anyone could potentially host this sprint! What you would need to do:

  1. Put your name on the sign-up sheet linked from https://events.drupal.org/neworleans2016/sprints -- you'll need to insert some rows and start a new section for a Documentation sprint, put yourself down as the organizer of the sprint, and mark which days you will be available for sprinting. In the Notes column on the far right, note that the purpose is to work on editing the User Guide.
  2. Before the sprint day, familiarize yourself with the editing tasks contributor instructions (site access login: drupal / drupal). The link to these instructions is in each issue summary too.
  3. You might also want to look through the issue list before the sprint day, if you have time, to familiarize yourself with what tasks are available. Again, look for issues whose titles start with "Content edit" or "Copy edit" on https://www.drupal.org/project/issues/user_guide
  4. Show up for the main sprint day on May 13 at DrupalCon New Orleans (and any other days you signed up for), and hopefully the organizers will help you set up a table or area for the Documentation sprint.
  5. Welcome and help anyone who comes to the sprint. Typically, they will need help and advice with:
    - Choosing a task/issue to work on -- you might point people who are new to sprinting and contributing to the "Content Edit" tasks, as these will probably be easier for them to complete (they will not require patches, see below, and are fairly quick).
    - Installing Git. You can also send people to the first-time sprinter workshop, where they will hopefully be guided through Git installation and basic use.
    - Getting a copy of the project files ("git clone") -- again the first-time sprinter workshop could be helpful.
    - AsciiDoc formatting, possibly... although for these editing tasks, the formatting should be fairly straightforward. (The User Guide is written using a markdown-style formatting system called AsciiDoc... there is information about this in the instructions linked above.)
    - Making a patch ("git diff"). Note that some of the tasks do not require people to make a patch (if only a small number of topics are edited).

Even if no one wants to be a formal host for the sprint, it would be great if several people wanted to meet in the sprint room and work on the User Guide issues together. Anyone who wants to do this would also be encouraged to sign up on the sprint sign-up sheet.

Thanks!

Documentation

Group categories

Event type

Post type

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds: