Help us out with the core documentation rewrite!

Gurpartap Singh - December 7, 2008 - 07:20


If you ever wished that the help documentation that you get inside your Drupal installation was just a little different, a little better, well now you can really step up and make a difference. Drupal 7 will, hopefully ;-), see the introduction of a new and completely overhauled Help system (read: we're starting over from scratch). However, this complete revamp means that all of the existing documentation must be re-written in order to work with the new system. So, it's our job to re-document the core modules.

This is not a job for one person! We need everyone to pitch in and help (no pun intended :-)). If everyone can even write just two pages, then we'll be very well off. In fact, we'll have all the help pages for the core modules done in a matter of days. And guess who it starts with? You!

So, the nice people at the Help System group on groups.drupal.org have assembled a work-flow for you to take part in.
Here's how to write the new help page for any module:

  1. Log in to groups.drupal.org. If you don't already have an account, you can log in with your_drupal.org_username@drupal.org as your user-name and your Drupal.org password.
  2. Navigate to the Help System group.
  3. Before adding a new page, check if it already exists. Search for it along the left of the Help System Group page, click on it, and click the edit tab.
  4. Can't find it? So you'll need to add it. Create a new wiki page in the Help System group.
  5. Choose "Drupal Documentation Task" from the "Group categories" drop-down.
  6. Choose the name of the module for which you want to write documentation from the "Help topic module" drop-down.
  7. Fill in the title and the body, and start writing the page. Be sure to adhere to these guidelines.

Some things to note:

  1. The topic titles of each module, on the left side of group page, are not listed in any order (although the modules are). The final order will be decided later.
  2. We are not using the Drupal.org handbooks for this, because there are specific styles and patterns that we need to follow for the new Help module's requirements. Check the comments at http://groups.drupal.org/node/17287 for further information.
  3. You can read up on the patch that will provide the new Help system in the issue queue.
 
 

Drupal is a registered trademark of Dries Buytaert.