Biggest challenges from previous periods:
- Slow processes, mainly in making decisions, even with simple things.
- Lack of response from other contributors (e.g. commenting on p2 posts)
This post should serve as a rough (or not so rough) focus plan and set of goals for the Docs team in the first quarter of 2021.
Content team
@atachibana – Contents migration team will complete the task (hooks and classes migration) within a Q1.
End User Block Editor team
@bph –
- We are triaging Gutenberg Changelogs 9.3 – 9.9 for End-User relevant changes in “Features” and “Enhancements” coming to 5.7
- Beginning of February – A team sprint to prepare next set of tasks
- Replace “More Options” section with link to “More Options”-page
- Outline of Full-Site-Editing documentation for 5.8
- Ongoing recruiting and onboarding of new contributors
- Team checking on current workload.
- Fielding Feedback from readers.
Design team
@estelaris – design proposal:
- P2 new reqs – week 4
- p2 new classification – week 6
- p2 on final navigation – week 8
- p2 on templates draft – week 10
- p2 proposal new design for documentation – week 13
Plugin Developer Handbook
@themiked – Based on the discussion here (1), the Plugin handbook will develop a way to indicate obsolete docs on both a page-level and a section-level. This will be done with an eye towards it being used elsewhere.
The modernization of the handbook is ¼ of the way done. There are four primary steps in this process:
- Convert content to blocks – done
- Edit content for clarity and consistency of tone
- Confirm that every code snippet conforms to best practices (phpcs, phpcbf, proper naming, good use of comments, and that it actually does what it says it does)
- Revisit of the writing to conform to the style guide, whenever that is finished.
(1) What to do with old/obsolete documentation – Make WordPress Documentation
Block Editor Handbook
@justinahinon – improving the structure of the block editor handbook: https://make.wordpress.org/docs/2020/08/13/plan-proposal-for-a-new-better-structured-gutenberg-developer-documentation/
Plan
- Improve the structure and the design of the homepage – done
- Reorganize the handbook table of content (in progress – https://github.com/WordPress/gutenberg/issues/28460)
- Find a place for FSE documentation
- Overall, add design improvements were needed in the handbook
Keep up with Gutenberg: https://make.wordpress.org/core/handbook/references/keeping-up-with-gutenberg-index/
More Info (DevHub)
User Notes (DevHub)
@audrasjb, @crstauf – stay on top of pending user notes: check regularly and optimize process for handling feedback for doc changes.
They also regularly open Trac tickets when the comments raise issues located in WordPress Core docblocks.
Common APIs Handbook
External Linking Policy
@themiked, @milana_cap – Finish first and the second phase of reviewing Plugin Developer Handbook: https://make.wordpress.org/docs/2020/12/01/external-linking-policy-1st-review-of-plugin-developer-handbook/
Documentation Handbook
This project was neglected in the past quarter. We should make some time to review it and pinpoint spots that need updating.
Contributing Videos
After having two videos published we neglected this project as well. Perhaps we could plan for a couple of more in this quarter.
Google Season of Docs
- Finalize and complete the Style Guide by March 1, 2021.
- Write the project report.
- Parse the GitHub repo to make.wordpress.org/docs/style
- Initial public release of the Style Guide.
Onboarding New Members
- Set up an automated slack bot to welcome new members with links to relevant resources.
- Add the mentorship team to the handbook
- Call word for mentorship (a word people can use in the slack channel that automatically ping members of the team)
HelpHub Localisation
Locales updates
@audrasjb: the French Documentation Team nominated two team leads (@jdy68 and @chaton666) and we’re now at 50% of coverage. In early 2021, we started to create our own original contents.