Tips for contributing to documentation

Last updated on
2 July 2023

This page provides an overview of some common questions with brief answers and links to more information.

I'd like to contribute to documentation. How do I get started?

  • Be bold! If you find a documentation page on Drupal.org that needs updating, editing, or additional detail, click on Edit and edit the page (You will need to log in.)
  • Try out a task in the Documentation area on the Find a Task page, or check out the tasks listed on the sidebar of the Technical Writing or Editing skill pages
  • Join the #documentation channel on Slack, where new opportunities for contributing to documentation are frequently posted

I'm a new contributor to Drupal documentation and am eager to help out. What sort of things do I need to know?

When is it 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. Are you afraid you'll make a mistake? No worries : There is a revision history and documents can be reverted if you do mistakes.

What can I do about outdated or duplicate documentation?

See Policy on obsolete and outdated documentation.

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 and log in. Then, depending on your comfort level, either:

  • Edit the page directly by clicking on Edit
  • Create a new issue for the Documentation project

What are all these references to d.o, a.d.o, g.d.o, and l.d.o I am seeing?

These are shorthand references to drupal.org, api.drupal.org, groups.drupal.org, and localize.drupal.org.

How do I change the API documentation?

The API reference on api.drupal.org is generated from specially-formatted comments in the code. Changing it requires a software patch. See:

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. The preferred image size to use in documentation is 620x700 pixels.

Yes, but try not to add too much external links. If there is documentation on drupal.org, link to that, but do not duplicate on drupal.org documentation about external tools that is already available on other sites.

Help improve this page

Page status: No known problems

You can: