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.

Maintainers

Each translation of the User Guide has one or more maintainers, its own issue "component", and the in-progress translation can be viewed on drupal.org:

Language Maintainers Issues View
English (and overall project) Joe Shindelar, Amber Himes Matz English content issues View EN guide
Catalan (Català) Ramon Vilar Gavaldà CA issues View CA guide
Simplified Chinese (简体中文)
Qiangjun Ran
ZH-HANS issues View ZH-HANS guide
Farsi/Persian (فارسی)
Navid Emami
FA issues View FA guide
French (Français) vanessakovalsky and Felip Manyer i Ballester (FMB) FR issues View FR guide
German (Deutsch) Michael Lenahan, Joachim Namyslo, and Markus Schmitt DE issues View DE guide
Hungarian (Magyar) Balu Ertl HU issues View HU guide
Indonesian (Bahasa Indonesia) Pratomo Ardianto, Suryanto Rachmat ID issues View ID guide
Japanese (日本語) Takashi Kabetani JA issues View JA guide
Brazilian Portuguese (Português - BR) Daniel Carvalhinho PT-BR issues View PT-BR guide
Russian (Русский) Ivan Abramenko,
Sergey Trubitsyn
RU issues View RU guide
Spanish (Español)
Juan Olalla
and
Guiu Rocafort Ferrer
ES issues View ES guide
Ukranian (Українська)
Alex Mazaltov Bondarenko
,
Andriy Prokopenko
, Andrii Podanenko
UK issues View UK guide

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

The current working branch for the project is the 10.0.x branch. This is what gets published on Drupal.org, and edits to the guide's content should be made in this branch.

We currently make "branches" of this project corresponding to Drupal Core major 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.
  • We used to make 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. But that resulted in lots of branches with no difference between them. So for now we only increment the minor version when the new minor version of Drupal core requires significant changes to the guide content.
  • Translations into 10 languages are in progress on the latest branch.
Supporting organizations: 
Initial authoring and ongoing maintenance

Project information

  • Created by jhodgdon on , updated
  • Arrow iconDrupal 10 is here!

    Content is updated for Drupal 10.

  • shieldStable releases for this project are covered by the security advisory policy.
    Look for the shield icon below.

Releases