Welcome to the second This Month in Drupal Documentation!
"This Month in Drupal Documentation" (TMIDD) is an approximately monthly update from the Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last month or so. Sorry... because this is posted in the Core group as well as Documentation, comments are disabled.
If you have comments or suggestions, please see the DocWG home page for how to contact us. Thanks!
Notable Documentation Updates
- A lot of work was done on the Drupal 8 core Help pages (admin/help within a Drupal site) this month, by many contributors. We still have a few Core modules that need to have their help reviewed or updated from what it was in Drupal 7. To help out, see https://www.drupal.org/node/1908570 -- find a child issue in the sidebar that is still open.
- Progress was also made on the developer documentation embedded in Drupal Core source code files. There's an effort underway to make sure that if you go to https://api.drupal.org/api/drupal/8 (the Drupal 8 landing page for API docs), you'll see a list of the key developer topics, and if you click through to any of them, they'll give you the essentials and link you to further details. The landing page is up, and this month most of the landing pages were filled in. If you'd like to help complete this project, see https://www.drupal.org/node/2148255 -- find a child issue in the sidebar that is either "active" (needs to be written) or "needs review" (has a patch that needs to be reviewed).
- brycefisherfleig updated the documentation for the Video module: https://www.drupal.org/documentation/modules/video
- lolandese wrote documentation for the Flickr module: https://www.drupal.org/node/2170535
- Sutharsan and others updated documentation for Drupal 6/7 to 8 migration: https://www.drupal.org/upgrade/migrate
- Many people wrote and updated Drupal 8 programmer documentation: https://www.drupal.org/developing/api/8
- acabouet updated titles for a lot of pages so they were clearer. You can do this too -- see https://www.drupal.org/contributor-tasks/fix-page-titles
- andreathegiant and others updated the documentation for COD (Conference Organizing Distribution): https://www.drupal.org/node/1837770
See note above on Suggestions if you'd like to be listed here in our next post!
Thanks for contributing!
Since May 29th (our previous TMIDD post), 262 contributors have made 1216 (wow!) total Drupal.org documentation page revisions, including 8 people that made more than 30 edits (lolandese, acabouet, drupalshrek, jhodgdon, gisle, realityloop, brycefisherfleig, and Gábor Hojtsy) -- thanks everyone!
In addition, there were many many commits to Drupal Core and contributed projects that improved documentation -- these are hard to count, because many commits combine code and documentation -- but they are greatly appreciated too!
Documentation Priorities
The Current documentation priorities page is always a good place to look to figure out what to work on, and has been updated recently.
If you're new to contributing to documentation, these projects may seem a bit overwhelming -- so why not try out a New contributor task to get started?
Upcoming Events
- http://conf.writethedocs.org/eu/2014/unconf-berlin.html - Write The Docs, Berlin - July 19-20, 2014
- https://amsterdam2014.drupal.org/ - DrupalCon Amsterdam - Sept 29 - Oct 3, 2014
- http://bogota2015.drupal.org/ - DrupalCon Latin America, Bogotá, Columbia, Feb 10-12, 2015
Report from the Working Group
- We've been working on the Policies section of the DocWG pages, and it's taking shape. So far, it mostly contains existing policies, but we also recently discussed and adopted guidelines for what to do about obsolete documentation and added it there.
- We've streamlined the Contribute to Documentation pages so that they're actually possible to read in one sitting. There was a lot of obsolete and duplicated information in there; not so much now!
- We are still looking through all of the suggestions and ideas the community has had in the past for how to improve documentation policies, procedures, and tools (and achieve our goals). We are getting closer to making a list of priorities... watch this space for updates!
- Video files can now be updated on drupal.org on documentation (and other) pages. Check out this issue for more information: https://drupal.org/node/1246118
- The software on https://api.drupal.org was recently updated, mostly with new features for Drupal 8, including a list of Services (see right sidebar navigation) and displaying Traits. Thanks to the infrastructure team for making this possible (the new Drupal 8 features required PHP 5.4, and the site is running PHP 5.3, so it was a bit tricky!).