This month in Drupal Documention (May 2015)
Here we are again with an update from our Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last month or so. Because this is posted in the Core group as well as Documentation you can not comment on this post. If you have comments or suggestions, please see the DocWG home page for how to contact us.
Requesting a grant to write a Drupal 8 user manual
The Documentation Working Group is going to request a grant from the Drupal Association to fund a Drupal 8 user manual. This manual would be intended for site builders and site administrators at the “Newcomer” or “Learner” level. The manual would not be limited to Drupal Core, and not necessarily covering every module of Drupal Core. The manual would be under git version control and would be written in a text format that is easy to manage for technical writers. We just posted a proposal on groups.drupal.org to get feedback from the community.
Thanks for writing documentation
May 2015 was a productive documentation month with 247 people revising almost 900 pages on drupal.org. These were the most active editors:
- lolandese (130 revisions)
- holingpoon (30 revisions)
- joelpittet (23 revisions)
- xjm (20 revisions)
- Pere Orga (20 revisions)
- danigrrl (18 revisions)
- Pierre.Vriens (16 revisions)
- reinier-V (15 revisions)
- hestenet (15 revisions)
- dokumori (14 revisions)
- webchick (13 revisions)
- Patrick Storey (12 revisions)
- lshey (11 revisions)
- Aki Tendo (11 revisions)
Many thanks go out to everyone that helped improving Drupal's on line documentation.
Let's Talk About Documentation at Drupalcon Los Angeles
Documentation Working Group member Joe Shindelar presented a session together with his Lullabot colleagues Amber Himes Matz and Greg Dunlap about the state of Drupal documentation. They discussed the current issues in, for example, the community documentation on drupal.org and talked about possible solutions. If you missed it, you can find the recording on events.drupal.org.
Documentation Priorities
Our priority is currently Drupal 8 documentation. Plenty of work has been going on in reviewing the embedded help texts in Drupal 8 and this work is almost complete.
The remain issues are:
- Re-writing the D8 theming guide for the major changes due to the introduction of twig;
- Reviewing the installation guide;
- Updating the core module pages on drupal.org with content from the reviewed embedded help texts.
- Reviewing the D8 core module UI texts
The Current documentation priorities page is always a good place to look to figure out what to work on, and it has been updated recently.
If you would like to contribute to Drupal documentation, but don't know where to start, then New contributor task can be a good starting point.