Last updated October 30, 2012.
Comments on a Community Documentation 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 page") is a simple way to improve our documentation.
Anyone with an account on drupal.org can edit Community Documentation pages. Follow the steps below to begin rolling comments into pages.
- Pick a page to work on. Use the Documentation Management page to find a list of documentation pages that have comments (you will need to be logged in to see this page). You can sort or filter to find pages with a lot or just a few comments. Or, pick a page that covers a topic which you feel particularly capable of editing (you can use a title keyword search to find one, or filter by which Book it is part of. Note that the Community Initiatives, Drupal and Google Summer of Code, and Events are not part of the Community Documentation and should be left alone unless comments are support requests or spam.).
- 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.
- 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 [username]".
- What not to roll into the text:
- Comments that are clearly software bug reports: convert the comment into an issue and file it under its appropriate project.
- Comments that are support requests: you can file an issue on their behalf in the appropriate project's issue queue and then notify them of the new issue. Or just email them using this template.
- Create an issue to delete the comment or comments. Use the following settings:
- Component: Manage comments
- Category: task
- Be sure to indicate in the body of the issue which comments you rolled in, and the URL of the page you were editing.