Selecting the Component for a Documentation project issue
Last updated on
17 September 2020
Every project can define its own issues components. Here is a list of the component in Documentation project issues:
- Correction/Clarification:
This is for existing documentation. If documentation is unclear or wrong, choose this component. For example, content is actually wrong and needs to be updated or something is just blatantly confusing. Better yet, just edit the page instead of filing an issue, or add a comment to the page explaining what needs to be fixed, and edit the page to change the Page Status to "needs technical review" or another appropriate status. - Missing Documentation:
If you have suggestions about adding documentation that is currently missing, either sections or content, use this component. - Placement/Navigation/Structure:
Content should be moved to a different section because it would be more relevant there, or pages should be split up or combined. Better yet, just go ahead and make the change. - Manage Comments:
Comments have been incorporated into the text of the page, or they are not useful, and they need to be deleted. - Vandalism/Spam:
Use this component and link it to the page(s) defaced. But if something is blatant spam (such as adding a comment with links to a fake watch site), report it in the Drupal.org webmasters project instead). - Docs infrastructure:
If you have suggestions on how to improve drupal.org's infrastructure in relation to the documentation process. - Unlock pages:
See Pages locked to editing - Other Documentation Issues:
If for some reason, your issues do not fall into the preceding component categories, use this one. - API documentation files:
Issues related to the API documentation files, such as the Form API reference, that are managed in the Documentation project.
Help improve this page
Page status: No known problems
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion