On this page
- Current Goals and Projects
- Help Topics in Core
- Contributor Guide
- User Guide
- Past Goals
- What are we working on?
- More details for each of these goals
- Make usability improvements to Documentation on Drupal.org.
- Improve existing Community Documentation by consolidating, re-organizing, and revising it.
- Create a new Getting Involved Guide, where new and experienced contributors can find fulfilling ways to get involved or deepen their involvement with the project.
- Introduce a new system for topic-based help within a Drupal site, and create topics for this system.
- Maintain and translate the Drupal User Guide.
- Introduce a new class of “Official” documentation.
- Who are we?
Documentation and Help Initiative
The goal of the Documentation and Help initiative is to improve the Drupal evaluator, developer, and site builder experiences through improved documentation on Drupal.org, and improve in-application help via a new topic-based help system.
Current Goals and Projects
Help Topics in Core
- Goal: A better system in Drupal core for in-site help, including help topics for common administrative tasks and all of the core modules in Drupal core.
- Status: (8 Mar 2024) All Help Topics module code has been merged into the main Help module in Drupal 10.2.0. A BC layer remains in core/help_topics. The experimental Help Topics module should no longer be enabled; use Help module instead. Topics for core modules have been into their respective module's help_topics directory. Remaining core.* and help.* topics live in core/help/help_topics.
- Issues: Search the Drupal project issue for keywords, "topic", using the component, "help.module" to find issues related to improving Help topics.
- How you can help: Write help topics for your modules or the modules you use. In a module's .module file, find the
hook_help()
implementation. This function contains the "Module overview". Extract the text from it and create one or more help topics for the module. See the documentation, Help Topic Standards for guidance. Join the #documentation channel in Slack to ask questions or discuss issues.
Contributor Guide
- Goal: A way for members of the Drupal community to learn about how they can contribute their time constructively.
- Status: (8 Mar 2024) We have content types (for Skills, Tasks, and Roles) and a landing page for the Contributor Guide. The old Getting Involved Guide has been migrated into the Contributor Guide and the Developer Guide.
- Issues: Meta issue for creating more content, organized by contribution areas: #3137918: [Meta] Create content for Contributor Area sections.
- How to get involved: See issues above. Join the #documentation channel in Slack to ask questions or discuss issues.
User Guide
- Goal: A tutorial to learn to use the main features of Drupal to build web sites.
- Status: (8 Mar 2024) The completed User Guide is available on drupal.org; you can also download PDFs and other ebooks. Translations into over 10 languages are in various stages of completion, and can also be viewed/downloaded from those same pages.
- Project page: https://www.drupal.org/project/user_guide
- How you can help: There are occasionally issues to update the content of the User Guide (as Drupal evolves, to fix problems, or to add information). You can participate by providing "patches" to update the User Guide, or reviewing patches. If you can translate from English into another language, you can join a translation team to translate the User Guide into your language, or start a team if there isn't already one for your language. See links on the project page for more information.
Past Goals
The information below is being evaluated to see what is current and what isn't, as of March 2024. Focus on the part above!
What are we working on?
Efforts within this initiative focus on these goals:
- Make usability improvements to Documentation on Drupal.org.
- Improve existing Community Documentation by consolidating, re-organizing, and revising it.
- [OUTDATED] Create a new Getting Involved Guide, where new and experienced contributors can find fulfilling ways to get involved or deepen their involvement with the project.
- [DONE] Introduce a new system for topic-based help within a Drupal site, and create topics for this system.
- Maintain and translate the Drupal User Guide.
- Introduce a new class of “Official” documentation for drupal.org that will be version controlled and subject to a review process that will enforce documentation standards. Strong efforts will be made to clearly define the standards and scope of this documentation, and to prevent duplication of existing content.
More details for each of these goals
Make usability improvements to Documentation on Drupal.org.
- Add Clickable Anchors and Table of Contents to Documentation Pages
- Design top level landing page for the new documentation system
- Add UI element that permits switching between Official Guide branches (7.x, 8.5.x, 8.6.x, etc.)
- All issues tagged with Documentation Initiative
Improve existing Community Documentation by consolidating, re-organizing, and revising it.
- Refactor Information Architecture of Documentation section
- All issues tagged with Documentation Initiative
Create a new Getting Involved Guide, where new and experienced contributors can find fulfilling ways to get involved or deepen their involvement with the project.
The existing Getting Involved guide on drupal.org is difficult for people to navigate in order to find ways to get involved. So, there is an initiative to make a better guide. Links and information:
- Main "meta" issue: #1414988: [Meta/Plan] Create a new Getting Involved Guide section and follow-up plan #3031642: Deprecate hook_help() and combine with Topics
- Issue list
- This initiative has meetings every two weeks on Tuesdays at 1600UTC time in the #documentation Slack channel.
Introduce a new system for topic-based help within a Drupal site, and create topics for this system.
In Drupal Core 8.8, the new core Help Topics module will be introduced, at "Beta - Experimental" status. We are now working on moving this module and its topics from Beta to Stable status, at which point it will be merged into the existing core Help module. Links:
- "Roadmap" issue, with links to individual issues that need to be resolved to get the module stable: #3027054: Help Topics module roadmap: the path to beta and stable
- Meta issue for creating new topics for the module, with links to individual issues to create small groups of topics: #3041924: [META] Convert hook_help() module overview text to topics
- Help topic standards
Maintain and translate the Drupal User Guide.
The User guide is updated as Drupal Core evolves. It is also being translated into at least 10 languages, with 2 translations finished and others in progress. Links:
- User Guide project page -- shows which languages are being worked on, and their coordinators.
- User Guide issue list
- Contributor Guide
Introduce a new class of “Official” documentation.
- Create repository for Drupal "Official Documentation" (for one page guides)
- Setup basic repo structure and scripts
- Draft standards for one-pager guides (in repo)
- Create template for one-pager guides (in repo)
- Specify requirements for Quick Start Guide
- Draft Quick Start Guide (in repo)
- ...
- All issues tagged with Documentation Initiative
Who are we?
The Documentation Working Group is driving this, and the initiative members include:
- @grasmash (coordinator)
- @svettes
- @littlekope0903
- @eojthebrave
- @amber-himes-matz
Interested in becoming a Documentation Initiative team member? Contact @grasmash via the #documentation channel on Drupal Slack. Team members are asked to make a commitment to attend meetings and contribute to the initiative regularly.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion