Note: This issue is closed -- for follow-up comments, please use one of the other issues referenced in this summary. Thanks!
The current Documentation on drupal.org is not well maintained, because it has grown to the point that it is not really maintainable by a formal Documentation Team:
- Because anyone can edit and add pages, it grows into a pile of spaghetti, with a few nice meatballs of great content sprinkled throughout.
- Even though they have permission to do so, people are afraid to click "Edit" to fix pages, and the status of pages (a taxonomy) is not updated because people don't realize they can change it if they click "Edit". Instead, they tend to add comments, which introduces more maintenance problems.
- Having the expectation that this documentation is overseen by the Documentation Team leadership has led to several past docs team leaders burning out, and is unsustainable.
This issue is primarily for discussing the minimum initial changes needed to resolve this problem which has been done, so this issue is now closed. Thanks!
Discussions for additional improvement ideas should happen on this follow-up issue:
Discussion regarding the redesign of the navigation portion of the page has been moved to this issue:
Discussion of a new "curated" docs area that is more tightly controlled is being discussed on:
And in the Remaining Tasks section below, there are a few follow-up issues for specific ideas.
The first step in resolving this problem is to turn the current Documentation into "community documentation". In other words, we need to remove the expectation that there is a Docs Team who maintains this documentation, and replace it with the expectation that the community as a whole maintains this documentation. The formal Docs Team will only be responsible for moderation and infrastructure.
What needs to be done in order for this to happen:
Have headers/sidebars that make it clear that it is maintained by the community, and that they can/should edit it and add to it, and that you need to "edit" to change status if a page needs work.
Provide discussion ability on each page (which, as a note, we already have with comments).
Full edit permissions with images and (hopefully, future?) videos for all on all pages.
Moderators for spam removal and dispute resolution.
Some way for people who want to improve the doc to find pages that people have identified as problematic.
Edit the Contribute to Documentation section and Docs landing page sidebar to reflect this new reality.
The plan is to roll this out in several phases, as indicated below.
- [phase 1] (a) above (header/sidebar redesign). Issue (DONE!):
- [phase 2] In the proposed mockup: We want each Book page to be able to reference one or more contrib projects. Issue (assigned, in progress):
- [phase 1] New taxonomies for Book pages: Level (beginner, intermediate, advanced). And Keywords (tagging). (presumably this is in the drupal.org admin UI). Issue (DONE!):
- [phase 3] (b) above - We might want to use the Talk module to move the comments to a different tab,
or use forums for discussion? Issue (in discussion) Note: we had considered using forums for this ( ), but the thought currently is that this is too big of a change, and we'll probably keep using regular comments for now. If we used forums, we would need to convert the existing page comments into forum posts, so they can become the new discussion tabs (in a database query in a drupalorg.install update function?). And we would also want to turn off book page comments with another database query. And we would also want to revive existing dead/deprecated Documentation forum http://drupal.org/forum/33) (presumably this is in the drupal.org admin UI) TBD
- [phase 1 or ASAP] (c) above: Now that has been deployed, we need to also figure out which pages are OK to change the input format back to Filtered HTML (probably most that are currently Documentation), and do that in a big database query. This is issue (NEED INPUT ON THIS):
- [phase 2] (d) above: We need to recruit moderators - TBD - and it's also part of the "edit contribute pages" (item f).
We also need to add a flag to the page to report it to moderators.Note: Each time someone reports a page, it will create an issue, and this is now part of the redesign item #1.
- [phase 2] (e) above: We already have http://drupal.org/documentation/manage . It will need to be tweaked a bit since we won't have comments (maybe),
and we will have a flag for moderation, but if people are updating status and starting discussions, this should be enough. It does need to have the new taxonomy added to it. Issue:
- [phase 3 or ongoing] (f) above: Editing Contrib to Doc - (DONE!) (see also item d).
- [phase 2] Need to edit the sidebar block about help maintain on the http://drupal.org/documentation page -- should wait until things are closer to deployment probably. Issue (in progress):
- [phase 3] Once this whole thing is deployed, convert existing issues in doc project into forum posts with appropriate book refs or comments (or whatever we are using for discussions) (this is a manual process, to be done in a sprint). Issue (in progress):
- Issues asking for new docs to be written can be closed as "won't fix" with a comment saying we aren't using the issue queue for this any more. Same for structure/placement/navigation issues.
- Issues pointing out problems in pages will have to be gone through manually. For each one that is open, the page status should be changed to something appropriate, and a comment added to the page pointing to the issue and saying 'this has been identified as needing to be fixed', and then closed as "won't fix" with a comment saying we aren't using the issue queue for this any more. I think we can make a process for this that sprinters can deal with.
- Issues in the API docs and Spam/Vandalism queues can be left as-is.
- Issues in the "apply to be a docs admin" category should be gone since that was mostly for image permissions.
User interface changes
The headers, nav tabs, and sidebar of current documentation pages will change as described above.