Incorporating comments

Comments on a handbook page often add clarification, more up-to-date information, or corrections. Incorporating the material from these comments into the body of the page (or "rolling comments into the handbook") is a simple way to improve our documentation.

Anyone with an account on drupal.org can edit documentation pages. Follow the steps below to begin rolling comments into the handbook.

First, view the list of all handbook pages that have comments in the "Documentation team links" section of the right column. Please note that the Community Initiatives, Drupal and Google Summer of Code, and Events are not part of the Drupal Handbooks and should be left alone unless comments are support requests or spam.

1. Pick a page: Start at the bottom for those with only 2 comments, or start at the top for those with many comments. Or, pick a page that covers a topic which you feel particularly capable of editing.
2. Review: Read the page, read the comments, and determine if there are useful corrections or additional information in the comments. If you are not sure about the information's accuracy, either test the code or verify the information yourself, contact the original author (whom you can identify under the revisions tab), or contact an authoritative source (e.g. the module maintainer) to ask them for clarification.
3. Roll it: Edit the page for corrections and additional useful information that would be good to include in the page. Create a new page (often a child page) if there is new information that is separate from the page's principle topic or focus. The Log Message revision note should, if feasible, credit the person who provided the information; "Rolled in information from comment by ." If the comment is clearly a bug report, convert the comment into an issue and file it under its appropriate project. If the comment is a support request, you can file an issue on their behalf in the appropriate queue (if one exists) and then notify them of the new issue or email them using this template.
4. Create an issue to delete the comment or comments. Use the following settings:
   • Project: Documentation
   • Component: Delete comments
   • Priority: normal
   • Assigned: Unassigned
   • Category: task
   • Status: active

   The title can be as simple as "Delete comments." Put a link to the page in the body. You may group many pages on one issue. If only certain comments were incorporated, then be explicit providing those incorporated, or by exception (those not incorporated). You can specify which comments by URL of the comment or title of the comment. Don't forget to include a link to the page/node you are correcting.