Selecting the Project for a documentation issue

Last updated on
14 January 2021

There are several types of documentation on the *.drupal.org web site family. If you find a problem with documentation, log in and see if there is an Edit button on the page. If there is, you may feel free to edit the page to fix the problem. If there is not an Edit button on the page, or you do not have the knowledge or writing skills to fix the problem you found, you may instead create an issue to report the problem.

All issues must be assigned to a particular project (see Overview of projects and issues for background). Documentation problems can fall under many projects. It is possible to create an issue by visiting https://drupal.org/node/add/project-issue -- and if you do that, the first thing you'll have to do is to choose a project. With literally thousands of projects to choose from, you will probably find it easier to use one of the links below (which will pre-select the project).

If you have found a problem with:

  • Spam:
    See Reporting spam.
  • User guide:
    Use project "User guide" for issues related to the Drupal User Guide.
  • Module, Theme, or Distribution documentation:
    If the issue pertains to a particular contributed module, theme, or distribution's documentation, choose the project for that module or theme. It's easiest to start by visiting the particular project page, find the Issues link in the right sidebar, to arrive at the project's issue list. Search first to see if the issue is already reported, and if not, click the "Create new issue" link, and fill in the following information:
    • Category: bug report
    • Component: Documentation
    • Title/Body: Describe the problem you have found clearly
  • API documentation on api.drupal.org:
    Use project "Drupal core" for issues related to the API documentation on api.drupal.org -- the documentation there is generated from the files in the Drupal core project. The easiest way to create an issue is to click the "Create an issue" link on the api.drupal.org page that has the documentation problem. That will fill in most of the issue fields for you, and you'll just need to add a description of what the problem is to the title and body fields.
  • Help text for Drupal's core functionality:
    Use project "Drupal core" for issues with Help text within a Drupal installation's core functionality, and fill in the following fields:
    • Category: bug report
    • Component: Choose the core module whose help has the problem
    • Title/Body: Describe the specific problem you noticed
  • Drupal.org online Community documentation:
    Use issue queue "Documentation" for issues related to the Drupal.org online Community documentation. See also: Issue Component field for Documentation issues. In a Documentation issue you can report:
    • A page that you don't have permission to edit (request that the page be unlocked so that you can edit it to fix the problem).
    • A major content problem, such as that a whole page or section needs to be updated for a new version of Drupal and the current text is completely unusable for the new version. (For minor problems, don't use an issue. The best solution is to edit the page directly, and the second-best is to add a comment explaining the problem, and then edit the page to change the Page Status to "needs technical review" or another appropriate status.)
    • A request for new documentation to be created that you don't know how to write.
    • A request for comments to be deleted, after you have incorporated them into the text of the page.
    • A report of inappropriate content (however, spam should be reported to the Drupal.org site moderators).
    • A group of people working on a specific set of new or improved documentation can also use an issue or issues in the Documentation project to discuss their effort. In this case, they should choose an issue tag for their effort, and make sure to tag all their issues with that tag.
  • Other pages on drupal.org: See Get Help

Tags

Help improve this page

Page status: No known problems

You can: