This Month in Drupal Documentation - January 2015

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.
ifrik's picture
Posted by ifrik on February 3, 2015 at 7:02pm

Here's an 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

  • Work is still ongoing on writing the so-called hook-help texts for the Drupal 8 core modules - that are the help texts that are displayed by the help module within your site. To help with this, see https://www.drupal.org/node/1908570 and find a child issue in the sidebar that is still open.
  • Most of this help texts need to be reviewed again, because this task started nearly two years ago and in the meantime UI changes have been made. An easy way of reviewing these without installing Drupal 8 locally is to use http://simplytest.me/ to roll out the latest Drupal 8 dev version. For more detailed information, see https://www.drupal.org/node/2283477.

The API reference site, https://api.drupal.org, has recently been updated:

  • The theme is now responsive.
  • Reference links for constants have been added, linking to functions that use the constant: see constant KernelEvents::REQUEST
  • There's a new Events topic for Drupal 8 that already has links to the Symfony event constants in it; more will be coming: see Events
  • Topic pages can now have sub-topics: see Views plugins

See the DocWG page for how to contact us, if you'd like to be listed here in our next post!

Thanks for contributing!

Since 1 January, 213 contributors have made 601 total page revisions, including 5 people who made more then 20 edits: lolandese, sidharrell, satraa, jhodgdon and webchick.

On the weekend 17/18 January, a global sprint weekend took place during which we also worked on documentation, working on the hook_help texts and the install.txt for Drupal 8.

Thank you to everybody who took part!

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.

The two meta issues to update and review of help texts currently have a high priority: Not only do we need them for a good user experience of Drupal 8, they also need to be translated once they are ready.
Working on them is also a good way to find out already how Drupal 8 will work for site builders and site administrators.

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

Report from the Working Group

Since there is a re-curring demand for curated documentation, the Working Group is discussing different option of how best to create and implement them.
In January, we also had a meeting with staff of the Drupal Association, to discuss the state of the of improvements on drupal.org to make documentation and related tasks more user-friendly.

Categories: , ,