Incorporating comments

Incorporating comments made on documentation handbook pages is one way documentation maintainers can usefully edit pages. Although documentation maintainers can not edit or delete the comments themselves, they can incorporate them into the page. An issue report can then be submitted, and a documentation team member who is also a site maintainer can easily remove the incorporated comments. This is also called "rolling comments into the handbook," similar to rolling code patches.

  1. View list of pages with comments at http://drupal.org/handbook/comments, which should also appear as a link in the right-pane navigation block "Contributor Links" under "Handbook tools" bullet.
  2. 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.
  3. Review: Read the page, read the comments, and determine if there are useful corrections or additional information in the comments. Some pages, such as older Summer-of-code pages, have a long string of comments used for discussion, and their incorporation is not intended.
  4. Roll it: Edit the page for corrections and additional useful information that would be good to have 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 note should credit the person who provided the information, such as "from comment by username." If the comment is clearly a bug report, convert the comment into an issue and file it under its appropriate project.
  5. Create an issue: Use the Documentation project, Task category, and Active status. 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.
 
 

Drupal is a registered trademark of Dries Buytaert.