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.
- Visit the E-book downloads page to download PDF, ePub, and Mobi versions of the User Guide
- 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.
- 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
- User Guide contributor chat (for editors, writers, translators):
On DrupalChat.me: https://drupalchat.me/channel/userguide
On Slack, use the #documentation channel - 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.
- Translation group managers should subscribe to the email list we use for announcements: https://groups.google.com/forum/#!forum/d8manual
- Automated tests and screenshot generation is now in a separate project: User Guide Tests
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:
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.
Project information
- Created by jhodgdon on , updated
- Drupal 10 is here!
Content is updated for Drupal 10.
- Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.