User Guide

This project houses the source files for the Drupal User Guide. It is not a module. The Guide was written in English, and has been partially to fully translated into at least 10 other languages.

You can view the User Guide online (HTML version, in English with links to other languages in the sidebar), or download PDF and other e-book versions. See the Links section on this page for more information and other options.

Status

The User Guide project was started during the Drupal 8 development cycle by the Documentation Working Group (DocWG), as a community initiative. Members of the community write, edit, and translate the guide, using templates and following guidelines provided by the DocWG.

The User Guide is now completely written and edited in English. It is also being translated into at least 10 languages, and you can see the in-progress translations of the Guide via links on the Guide pages.

Links

• Current HTML version of the User Guide, including English and partial/full translations into at least 10 languages.
• Download a release or the "development version" below, or click the "Browse code repository" link in the sidebar, to see the source code used to build the User Guide. There are also PDF and other e-book versions of the guide in the "ebooks" folder of the download (in the code repository, use "plain" links to download e-books).
• Folder where you can download PDF and other e-book versions.
• Contributor Guide. Contains, among other things:
  • https://www.drupal.org/docs/user_guide_guidelines/practicalities.html -- quick start guides for contributors, including translators
  • https://www.drupal.org/docs/user_guide_guidelines/pm-guide.html#pm-guide... -- instructions for starting a group to translate the User Guide into your language
• To display the User Guide in your own Drupal 7.x site, or import it into content items using the Feeds module, you can use the AsciiDoc Display module.
• Issue list for this project -- available tasks are tracked on issues (see Contributor Guide)
• Status, progress, "sprint" work days, participant meetings, and opportunities to get involved are announced in the Documentation group on groups.drupal.org. Join the group and subscribe to notifications to stay up-to-date.

Suggestions?

If you have suggestions or comments about the project, especially about templates, guidelines, or project management, please add an issue. You can also add an issue if you find a problem in the guide. There are issue "Components" in this project for project management, guidelines content, guide content, translations, and templates.

Note about branches/versions

We are making "branches" of this project corresponding to Drupal Core versions:

• We had an 8.x-0.x branch corresponding to Drupal 8.0.x when we started out.
• There was no 8.1.x version.
• The first finished English version was 8.x-2.x, corresponding to Drupal Core 8.2.x. We have new branches for each minor version of Drupal Core: 8.x-3.x for Drupal Core 8.3.x, 8.x-4.x for Drupal Core 8.4.x, etc.
• Translations into 10 languages are in progress on the latest branch.