Last updated April 10, 2012.
Updating and maintaining Drupal's documentation is an important project. For a new contributor, learning how how to contribute to the documentation can have a bit of a learning curve and often lots of questions arise in the process. This page attempts to provide an overview of those questions, with brief answers and links to more information.
As you can see, this page is currently itself a work in progress. ;) You are, naturally, encouraged to contribute.
I just want to suggest a one-off change to a page. How do I do that?
If you don't yet have an account on Drupal.org, create one. Then you can do one of several things, depending on your comfort level:
- Edit the page directly using the "Edit" tab (unless it is a locked page)
- If it is a locked page, create a new issue (which is like a ticket) in the Documentation project
- Leave a comment on the page itself, explaining the change to be made, and also edit the page to change the Page Status to something appropriate.
If you are trying to change API documentation, see "How do I change the API documentation?", below.
I'd like to contribute to documentation. How do I get started?
First, check out the New Contributors Tasks section on Drupal.org. There you will find many tasks for people new to contributing to the Drupal project, written out, step-by-step, with links to background information. The "Writers" and "Anyone" sections are especially suggested for those wishing to help with Drupal documentation.
For those wishing to delve deeper, we also have a longer how-to contribute to documentation guide available.
I've edited a few documentation pages, but I'd like to do more. What's next?
You can also check out other tasks in the New Contributors Tasks section on Drupal.org.
I'm a new member of the documentation team and am eager to help out. What sort of things do I need to know?
As you edit others' work and add new work of your own, be sure to keep the Style guide in mind and follow what it says. Others who are doing the same thing as you will eventually find your page and try to bring it in line with the style guide, anyway.
For a much bigger overview of contributing to Drupal's documentation, read the rest of the Contributing to documentation section.
I found a page that is completely out of date, or redundant. How do I remove it?
What are all these references to "d.o", "a.d.o", "g.d.o", etc. that I am seeing all over the place?
These are shorthand references to drupal.org, api.drupal.org, groups.drupal.org, etc. Other sites you may see referenced are qa.drupal.org and localize.drupal.org.
Some documentation isn't in the Community Documentation pages -- where is it?
Some kinds of documentation are kept in other locations:
- The API documentation for Drupal developers is auto-generated from files in git. To update the description of a file, function, topic, etc., see Updating API documentation.
- Embedded documentation is included with every Drupal installation.
How do I change the API documentation?
See Updating API documentation.
Can I upload larger images and get them automatically re-sized?
Drupal.org doesn't re-size images, so it is suggested that you resize images yourself before uploading. Read the Screenshots and uploading images doc for a guide.