Overview
‘Documentation’ is a top level Section of Drupal.org. A central place for finding and reading Drupal documentation. It contains general documentation on Drupal, and has clear contextual paths to project-specific documentation and API documentation.
More details on what is changing about documentation:
DC NOLA session slides
DC NOLA session video
Personas
The Section is focused on Skilled and Expert users, who consume documentation (Readers) and contribute to it (Editors and Maintainers).
Scenarios
List of user scenarios
Story map of the scenarios
Background
Documentation is a crucial part of any software product. Documentation Section is designed to help move Drupal.org users from Skilled to Expert, by enabling them to successfully build, maintain, and improve Drupal sites and Drupal itself.
Working group:
Building ‘Documentation’ Section and related documentation tool improvements supports 'Manage' and 'Use' groups of goals identified by Documentation Working Group, as well as covers all of their 2015 priorities.
Drupal Association:
Building ‘Documentation’ Section and improving documentation tools directly supports the two goals of the Drupal Association:
- to enable the focused, effective, efficient development of Drupal,
- to develop sufficient professionals to meet global demand for Drupal.
Additionally it indirectly positively affects the following goals:
- to ensure the sustainability of the project and community by creating more Experts and Masters who develop Drupal the software and contributed modules
- to increase Drupal adoption for customers with complex and changing needs including global markets.
User engagement and contribution
The types of user engagement and contributions we'll be able to (better) capture and display on user profiles:
- documentation edits (purely documentation, right now there is a lot of content created using book page content type, which is not documentation)
- documentation sections maintained
- documentation maintainers
Implementation details
- ‘Documentation’ is a top level Section of the site.
- Present in top navigation.
- It is an organic group.
- Includes sub-groups (per sub-section of documentation)
- Types of content created in this Section: documentation.
- Types of content displayed in this Section from elsewhere: none.
- URL: drupal.org/documentation
In progress:
#2218551: A user should be able to "follow" a Section of content
#2574783: Content Audit for documentation on Drupal.org
#2744915: Define new structure for documentation
#2762837: [Meta] Migrate documentation into the new system
Next steps:
#2679643: Connect projects to documentation guides
Done:
Usability testing for upcoming changes
#2578695: Use CKEditor on *.drupal.org sites
#2682073: Update documentation statuses and their display
#2679635: Create group content type (guide) for documentation
#2585027: Edits on documentation nodes should automatically generate comment
#2587331: Split documentation per Drupal version
#2584965: Display comments on a separate tab for documentation pages
#2574901: Survey book page visitors about their experience
#2574927: Setup Google Analytics tracking on book page
#1304216: A user should be able to "follow" individual pages of content and receive email notifications for new comments
#2585059: A user should be able to "follow" documentation pages
Comments
Comment #1
tvn commentedComment #2
tvn commentedComment #3
tvn commentedComment #4
tvn commentedComment #5
tvn commentedComment #6
tvn commentedComment #7
tvn commentedUpdated the summary with an overview of the Section and the work we'll be doing, as well as preparations we've done so far. The story map was developed with the help of Documentation WG members.
Going to open child issues for implementation now.
Comment #8
tvn commentedComment #9
ekes commentedNone of the links are accessible, all bring up a google account login. Can they be made public?
Comment #10
tvn commentedSure, they were public originally, something changed in the sharing settings. Should be public again now.
All the specific issues we'll be working on can be found by 'd.o documentation' tag:
https://www.drupal.org/project/issues/search?issue_tags=d.o%20documentation
Comment #11
tvn commentedUpdating issue summary, this initiative is now work in progress.
Comment #12
tvn commentedComment #13
tvn commentedComment #14
tvn commentedComment #15
tvn commentedComment #16
tvn commentedComment #17
tvn commentedComment #18
tvn commentedComment #19
tvn commentedComment #20
hestenetIn progress details about the new Documentation section were shared in our DrupalCon New Orleans session.
Comment #21
tvn commentedWe are currently focused on the final issue before we can launch the new Documentation section: #2744915: Define new structure for documentation. Feedback via comments is welcome.
Another issue (which is not a blocker) to provide feedback on is: #2744863: Delete Archive book
Comment #22
tvn commentedComment #23
tvn commentedComment #24
tvn commented