March 29th, 2012
Hello from Jennifer, your friendly Drupal Documentation Team leader! It’s time for a quarterly update on what’s happening in the Documentation team.
First off, I just want to remind everyone that I’m still planning to step down as Documentation Team Leader at the end of 2012. If you’re interested in becoming the co-leader or assistant leader now, and taking over at the end of 2012 as the main team leader, see http://groups.drupal.org/node/203258 for more information. It would be good to find someone soon!
- The Documentation Team is currently holding weekly “Documentation Office Hours”—one-hour IRC meetings on Tuesday afternoon (North American time), open to anyone for questions and discussions about contributing to documentation. This schedule is likely to change soon; join the discussion about a new time for office hours.
- The API documentation cleanup sprint from last quarter has continued into this quarter. The goal is to bring the Drupal 7 and 8 core API documentation much more in line with our documentation standards. To join in, visit the issue page.
Milestones and Accomplishments
- Lots of content was updated on Drupal.org this quarter. Of particular note:
- There used to be a “Community and Support” link in the top navigation of Drupal.org; now there are separate Community and Support links, and the Support page has been completely redone (a redesign of the Community page is also in the plans). Hopefully this will help people new to Drupal connect with the help they need to get started. Thanks to Lisa Rex, David Hernandez, and others for making this happen!
- The Omega theme project organized a group to update the Omega section of the Community Documentation.
- The Media module project organized a group to update the Media documentation.
- An effort is underway to create a Mobile section in the documentation.
- We started a New Contributor Tasks section on Drupal.org. This is a place where people new to contributing to Drupal can go to find meaningful and doable tasks to start with. If you have ideas for the section, there’s a page describing how to add to it (with templates), and a suggestions page too.
- 712 different contributors made a total of 3976 revisions to documentation pages on Drupal.org. Wow! (I have a new statistics page that totals this up). Apologies if your project didn’t make it into the list above — there’s a lot going on and I can’t keep track of it all!
- Neil Drumm and I (with the help of other patch contributors) are continuing to make updates to the software for http://api.drupal.org. This quarter, there were major improvements to the linking and references features of the site — check it out if you haven’t been there lately! If you would like to work on the API module, check out the issue queue (http://drupal.org/project/issues/api) or find jhodgdon in IRC to get oriented.
- I was given permission to commit Drupal Core 7/8 documentation and coding standards patches in February, and to help out in case of “Core Is Broken!!” emergencies. Hopefully this will lessen the burden on Angie, Nat, and Dries, freeing them up to concentrate on bugs that improve the Drupal software functionality.
Last year, the Docs Team (or at least its leadership) got a bit discouraged about Documentation infrastructure improvements taking quite a while to get deployed to Drupal.org. But now there’s a new process for getting improvements deployed, and Neil Drumm is working on them with hours funded by the Drupal Association. So, I’d like to get us working on improvements to “docs infrastructure” (tools, navigation, etc. for Drupal documentation writers and users) again.
I started working on that this quarter, and several small things were deployed. That went well, so there are now more in progress. Two that we hope to get done soon are a Docs Team effort to have better navigation for Community Docs, and LoMo’s project to replace the Books page with a content type/View. Join in the discussion and/or help out!
And as a preview, this summer I would like to really get working on the “curated docs” we’ve been talking about for a year or more… Watch http://groups.drupal.org/documentation-team for updates!
If you’re interested in helping with Drupal documentation:
- New contributors: Check out the tasks in the New Contributor Tasks section, or read http://drupal.org/contribute/documentation to learn all about contributing to documentation. Or come to the weekly office hours (see Events section above) to ask questions and get started.
- Drupal Documentation announcements, discussions, and events are posted on http://groups.drupal.org/documentation-team and on Twitter (@drupaldocs).
- API documentation cleanup sprint (for programmer-documenters): http://drupal.org/node/1310084
- Work on the API module: http://drupal.org/project/issues/api