Last updated May 29, 2014.
Updating and maintaining Drupal's documentation is an important project. For a new contributor, learning how to contribute to documentation can have a bit of a learning curve generating lots of questions in the process. This page provides an overview of some common questions with brief answers and links to more information.
This page is itself a work-in-progress. ;) Naturally, you are encouraged to contribute.
I'd like to contribute to documentation. How do I get started?
- First of all, be bold! If you find a documentation page on Drupal.org that needs updating, editing, or additional detail, use the edit button and edit the page.
- Try out a New Contributor Task -- there are tasks in both the Writers and the Anyone sections that are about contributing to Documentation
I've edited a few documentation pages, but I'd like to do more. What's next?
You can help to close issues in the Documentation issue queue, contribute to the discussions on the Documentation group page, or just edit some more pages. Or try out a different New Contributor Task.
I'm a new contributor to Drupal documentation and am eager to help out. What sort of things do I need to know?
- If you are doing a particular task, see if it is in New Contributor Tasks ("Anyone" or "Writers" section). This will have details and background information.
- Get familiar with the Documentation Guidelines and Policies.
- Look for things to fix in the documentation issue queue
- Join/subscribe to the documentation group on G.D.O.
- Join the Drupal Docs IRC channel #drupal-docs. If you are new to the concept of IRC or need some help getting set up, visit the D.O. Chat with the Drupal Community on IRC page.
When is OK to edit a documentation page?
- If you think that you can add clarity or information to a documentation page, go ahead and edit it. Afraid you'll make a mistake? No worries -- keep in mind there is a revision history and documents can be reverted if you do.
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
If you are trying to change API documentation, see "How do I change the API documentation?", below.
How do I get started with Drupal 8 documentation?
- One source for D8 documentation issues is by searching the Documentation issues queue for issues tagged with "d8docs"
- The Current Documentation Priorities page has some more suggestions for what needs to be done.
I found a page that is completely out of date, or redundant. How do I remove it?
Submit a new Documentation project issue so that someone with the necessary permission to delete pages can review it. If you're unsure of how to use the issue tracking pages, see Documentation issue reports.
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?
Can I upload larger images and get them automatically re-sized?
Drupal.org doesn't re-size images, so it is suggested that you re-size images yourself before uploading. Read the Screenshots and uploading images doc for a guide.
Can I add some external links in Documentation related to a topic ?
Yes, but try not to do this excessively. If there is documentation on drupal.org, try to link to that, or write the necessary documentation.