As a part of our ongoing effort to overhaul Drupal.org's content strategy (#1133434: [META] Content Strategy for Drupal.org), we are going to organize documentation pages on Drupal.org into a new 'Documentation Section'. The Documentation Section will be an organic group, with multiple organic groups inside of it to structure documentation into 'sub-sections' and assign maintainers to those 'sub-sections'.
Before we can do this re-structure, we need to audit current documentation and figure out what sub-sections we need inside of the Documentation Section. While doing that we can also check for outdated, duplicated pages, etc. We started work on the audit at DrupalCon Barcelona. The work was happening in this spreadsheet:
https://docs.google.com/spreadsheets/d/1zuoBbKtkuhJxgof1IRbcNsUihDuMiA9x...
Status:
Audit is done for most 'generic' documentation books. Most of them already have been migrated into the new system, see #2762837: Migrate documentation into the new system
Remaining tasks:
- Audit 'Reference' book and decide what to do (whether to migrate into the new system or not and where exactly to migrate) #2816021: Audit 'Reference' book
- Audit 'Tutorials and site recipes' book and decide what to do (whether to migrate into the new system or not and where exactly to migrate) #2816019: Audit 'Tutorials and site recipes'
- Audit 'Getting Involved Guide' #2816011: Audit 'Getting Involved Guide'
- Migrate pages in the 'Governance' book into the new Governance section #2338301: Create 'Governance' section
- Migrate content from the 'Security' book into the new Security section #1576318: Create 'Security' Section
Comments
Comment #2
dead_armWorking on this @Drupalcon Barcelona
Comment #3
dead_armSprinting on this @BADCamp this weekend.
Comment #4
hestenet@dead_arm - about to send you a contact form message as well - but I think I'm going to color code sections that contributors are working on - so that we can divide up the work without stepping on each other. We're focusing on Administration and Security guide at the moment.
Comment #5
dead_armComment #6
tvn CreditAttribution: tvn at Drupal Association commentedComment #7
tvn CreditAttribution: tvn at Drupal Association commentedComment #9
tvn CreditAttribution: tvn at Drupal Association commentedComment #10
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commentedI've tried to update this issue's description to match the overview tab on the Barcelona spreadsheet.
Does this spreadsheet want to be made readable (or maybe remove the overview tab)?
It would also be good to itemize what work is still required in order to close this issue:
* whether to open child issues for the sections that are still incomplete, and further itemize the tasks required.
* whether to open separate issues to cover what was audited as e.g. "will be dealt with later" and remove them from here entirely, so this isn't blocked by them.
* whether there are any follow-on issues or whether that's covered by the parent issue.
Comment #11
tvn CreditAttribution: tvn at Drupal Association commentedUpdating the issue summary.
Comment #12
tvn CreditAttribution: tvn at Drupal Association commentedRemoved done list completely. There are 5 remaining tasks to complete audit of the existing 'book pages'. Two of them have issues already. If someone wants to create issues for the other three, I will then update those issue summaries with the details of what exactly needs to happen there. Once we have those 5 issues, I think we can close this one as bulk of the work is done.
Comment #13
tvn CreditAttribution: tvn at Drupal Association commentedComment #14
jp.stacey CreditAttribution: jp.stacey at Magnetic Phield commentedI've added child issues for the other three remaining tasks and updated the description to match.
Note that I've copied the metadata off existing child tasks when creating the new ones. This does mean that all child tasks are in the "Drupal.org content" project, whereas this one is still in "Documentation". I've also guessed at the right books/guides to reference on the new child tasks. So they might need to be quickly checked for correctness.
Comment #15
tvn CreditAttribution: tvn at Drupal Association commentedThanks jp.stacey! I'll try to find some time and update those issues next week.
Comment #16
tvn CreditAttribution: tvn at Drupal Association commentedUpdated all the remaining tasks, going to close this issue as most of the docs have already been audited. (Removed related issues, as they already reference this one as a parent, so we don't have them in the sidebar twice).