Welcome to the official home of the WordPress documentation team.
This team is responsible for all things documentation, including the Codex (moving to HelpHub), handbooks, developer.wordpress.org, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
We need your help keeping content current with each WordPress release and adding new content and screenshots to:
We are editing those contents with Gutenberg (of course :-)) and will report some difficultlies and issues that we found to https://github.com/WordPress/gutenberg.
Phase 2 discussion
Phase 2 work will start after migration for Phase 1 is over as that is priority. Phase 2 issues are here. If you want to join this project, please contact to @zzap.
AOB
@netweb and @clorith are working hard to setup production site for HelpHub. Thank you!
As you might know from our meeting updates – HelpHub has taken awhile to finally materialise. One of the hurdles was working out a migration plan. Unfortunately, because of WordPress.org’s unique setup, we were not able to get things automated or even use WordPress’ import mechanisms.
This means that we actually need to specifically do manual migrations from the Staging site – wp-helphub.com to the Production spot WordPress.org/support
How are we doing it?
Specifically – we are doing the following
Use the Copy All Content function of the Gutenberg editor on an article on the Staging site
Paste it the content onto the Production site
Do the same for the title and check the correct taxonomies
In the case that it’s still using a Classic block, we’ll have to switch it to Gutenberg blocks
Ensure that all media used (pdfs, images etc) are downloaded and re-uploaded back to WordPress.org/support
Check it for irregularities
Save the draft
You might be able to appreciate that it is a pretty tedious process. By the time you read this post, we should be up to 30 of 170 articles completed. Another 140 articles is a lot to migrate for a team of 5.
Why the rush?
We want HelpHub to be ready for the Gutenberg team to drop in their user documentation. Given that WordPress 5.0 is designated to ship November 19, we don’t have a lot of time left.
We don’t want to leave users in the cold. And you could help us.
What can I do?
If you have some copy pasting skills, a keen eye for detail and an hour free over the next 2 weeks; you can help us!
Drop @atachibana (who’s the Content Lead) a line with your wordpress.org account and registered e-mail address. He will sort you out with the correct access and the know how.
If you have any questions, just ask in #docs on Slack.
Thanks to everyone who joined us for the kick-off Gutenberg docs meeting!
Below is a summary of last week’s meeting.
Opened with introductions and hellos, and a description of @chrisvanpatten‘s goals for the group
Set future meetings for 1pm ET/17:00 UTC on Tuesdays, in #docs on Slack
Discussion of where documentation would “live”
Goal is to continue allowing docs to be prepared in GitHub
@drewapicture raised some questions about what the Gutenberg handbook represents, suggesting it not exist as a mono-doc when merged into core
@kenshino raised the idea of splitting into separate handbooks: auto-parsed documentation in DevHub, developer handbook in DevHub, and user handbook in HelpHub
(@chrisvanpatten also added a contributor handbook to be considered too, likely to live on GitHub for now)
Established next steps:
Lock down high level documentation outline
Open a PR to reorganise the documentation
Determine list of holes in documentation
Begin assigning writing tasks in GitHub issues/high level project/milestone
Established next meeting for Tuesday, 30 October at 1pm ET/17:00 UTC in #docs
</meeting>
I’ll post an agenda for our next meeting tomorrow a few hours before the meeting. Thank you everyone who joined us!
There is a list of function, class and hook that are due for migration / redirection on a Google Sheet.
We had a good discussion around priorities for redirection (since many Codex’s code examples have been migrated already to the relevant DevHub pages) and it was decided that the priority will be setup in such a fashion:
Mirrored content – redirect all
Migrate high traffic articles (We don’t need 100% migration, there doesn’t need to be 500 examples for one functionality)
This is not yet a thing as HelpHub is being launched over the next few weeks. But it will eventually need people to help redirect Codex articles to HelpHub ones
HelpHub
We cleared the upload hurdle. And we’re working on doing manual migrations, (really copy and paste) because even text based imports failed.
@coffee2code has made sure that the WP Code reference now has the latest source code and documentation parsed in. This means the DevHib has up to 4.9.8’s code references recorded.
He has also added a WP-CLI command so that anyone with a sandbox can reparse the source in the future. (https://meta.trac.wordpress.org/changeset/7717)
@coffee2code was also working on the DevHub homepage revamp which looks like the wireframe here – https://meta.trac.wordpress.org/ticket/3377#comment:5 (This has already been done before the minutes were posted (late))
He’s also working on allowing users to edit their own comments (Code examples) on DevHub – https://meta.trac.wordpress.org/ticket/3572
Inline Docs
Because WordPress 5.0 is designated a Gutenberg release (mostly). It is likely the core inline doc changes won’t make it into the 5.0 release. If these changes are pushed, they will likely fall into the 5.1 release.
Docs Handbook Architecture
@milana_cap worked on recording the pages and fixed the paginations to show pages in proper order.
There still exist quite a few unfinished pages and @kenshino will take some days closer to the end of the year to write missing content
However, work to improve the Docs team handbook shouldn’t stop and volunteers are free to help improve it.
WordPress Contextual Help system
The WordPress Contextual Help system looks like this if you need help reminding (it looks like this)
The Docs team is responsible for the strings present within and we’ve not been looking at it for some time.
We’ll be slowly bringing this back into the Docs Team meeting.
We noted that the Contextual Help system is missing in Gutenberg as well.
You can view the meeting history in detail starting from https://wordpress.slack.com/archives/C02RP4WU5/p1539615616000100
