Current documentation priorities

Last updated on
8 August 2023

This documentation needs work. See "Help improve this page" in the sidebar.

This page outlines some of the current priorities for work on the Drupal documentation. It's aimed at more experienced Drupal documentation contributors, so if you start reading this page and you feel lost, skip down to the "Notes and Background" section below.

User Guide project!

We're working on a Drupal 8 User Guide! To help out with this, check out the User Guide project page. Current status: Translating to non-English languages.

Become a guide maintainer

We've recently migrated documentation into the new "guides" structure. As part of this process we're seeking maintainers for sections of the documentation. See #2682083: Recruiting guide maintainers for documentation for information about which guides are currently in-need of maintainers and to learn more about what it means to be a maintainer.

Documentation to Write/Update

  • See #2682083: Recruiting guide maintainers for documentation for a list of guides. Talk to their maintainers to figure out what content still needs to be written
  • UI texts: The UI texts need to be reviewed based on the reviewed help texts. For details, see #2499495: [meta] Review UI text for D8 core modules
  • Module developers guide: Drupal 8 introduces a number of important changes to the way modules are developed. You can help your fellow developers get up to speed by:
    • Reviewing the API and Module developer's guides: We need help reviewing the Drupal API guide and the Module developer's guide to see if there are places that need updating. If you find areas that need to be updated, please file new specific issues in the Documentation project. Tag the issues “d8docs" and “developer".
    • Updating the API and Module developer's guides: Updating areas in the API guide and Module developer's guide that have had issues filed noting they are out of date or incorrect. You can find these issues by searching for issues tagged “d8docs" and “developer" in the Documentation issue queue.
    • General API documentation issues: There are also some API documentation issues in the Drupal core issue queue that could be worked on, but these are mostly a lower priority than the areas noted above. You can find these issues by searching the Drupal core issue queue for open 8.x issues that are either in the “documentation" component, or tagged with “Needs Documentation".

Notes and Background:

  • Just click edit! If you see an Edit button or link on a page, that means you are encouraged to edit the page if you can make it better. Please do!
  • New contributors: If you are new to Drupal or new to contributing to Drupal documentation, the priorities listed here will probably not be the best place for you to start. Instead, please check out the New Contributors Tasks section. There are tasks in the "writers" and "anyone" sections that are related to Drupal documentation, and they will help you get up to speed quickly.
  • Even if you are not a new contributor, if you're doing a task that's listed in New Contributors, the directions and background information in the task writeup might help. Give it a look! You might also find a new task that you'd enjoy helping with.
  • The Drupal project has some documentation guidelines and policies you might want to review. See https://drupal.org/governance/documentation-policies

Infrastructure Projects

The Documentation Working Group (DocWG), which is part of the Drupal project governance structure, sets goals and priorities for documentation infrastructure and process improvements, and announces them on their home page or sub-pages, as well as in the Documentation group on groups.drupal.org.

If you would like to suggest an infrastructure or process improvement, file an issue in the Documentation project, using the "Docs infrastructure" or "Processes and procedures" components. You can also browse those issue components to see what has already been proposed.

Sprints

The Documentation page on groups.drupal.org is the place to go to find out about our current documentation "sprints"! Sprints are specific priorities to work on for specific time frames (if we have some...) -- join us!

Help improve this page

Page status: Needs work

You can: