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:
Hooks migrations are stalled for the last two weeks
I’ve been working in the localization content for the common APIs handbook. Hopefully this week I’ll manage to have something to show
Docs handbook review: This page https://make.wordpress.org/docs/handbook/helphub/migrating-articles/ have 2 sections talking about migrating the Versions pages. Apparently this taks is completed already and could be removed
During these works, I was suggested by johnbillion to report all inline documentation fix under the one ticket: https://core.trac.wordpress.org/ticket/48303
I modified Docs Team Handbook to relect this change: https://make.wordpress.org/docs/handbook/code-reference/inline-documentation/
The team at contributor day WC Valencia came up with good ideas, but after reviewing their individual input and adding the comments left on the P2 I posted 2 weeks ago, we came up with what it looks like the final version
Handbook
As discussed during our last meeting, our focus on this meeting was the Docs Team Handbook.
According to @milana_cap, our Handbook has been forgotten for a long time until recently when we started updating and reorganising it, each team member is responsible for a part on the Handbook, and may review and update all guidelines around it. It’s only natural that those people update the same parts of Handbook because they know the best how to contribute to that project and who to talk to.
@milana_cap also pointed out that we are also missing the Block editor documentation guidelines, and that we are missing someone who’s going to “own” it.
Then @felipeelia asks about the “Plugin Handbook Rep: Open” from the projects list.
@milana_cap remembers that plugin handbook is actually shared between plugin review team and docs, and that main ownership is by plugin team.
@Kenshino proposes about clarifies if the Plugin Team is updating the pages based on the latest changes to WordPress, and propose about contacting @ipstenu.
@milana_cap highlights that the main goal of the handbooks is that people that want to add something in notes or want to contribute, they should be able to go to our handbook, find info on how to start, which document to go to, which Trello board etc and which people to ping if they have questions.
@Kenshino gives the suggestion to create a P2 post, so we can set expectations and deadlines for people.
HelpHub
The plugin has been activated in several sites, but we are still waiting for content import into the sites. There is still not an estimation of its availability.
Next meeting & WCUS Contributor Day
We are going to be at WCUS 2019 Contributor Day, and @milana_cap has published a post about it: https://make.wordpress.org/docs/2019/10/28/docs-team-at-wcus-2019-contributor-day/
As we are going to be with limited resources next week, so the meeting has been canceled, and we will just have a meeting again on Nov 11 which will be hosted by @tomf.
Transcript
You can take a look at the meeting transcript via this link: https://wordpress.slack.com/archives/C02RP4WU5/p1572274864247300
Today we started with new meeting format. In order to make meetings more useful we want to try to keep updates as short as possible at the beginning of the meeting (or maybe even during day prior to the meeting).
Most of the meeting will be dedicated to one specific part of Docs team responsibility ― HelpHub is published and it will no longer have dedicated meetings every second week.
The rest of the meeting time will be used for quick discussions/decisions on any other part of Docs team work.
Also, whenever possible, it would be good to close the meeting with clear tasks for the next meeting.
Facilitators and note takers will be rotating. At every meeting one volunteer will be assigned for the next meeting.
Development: Development is blocked and waiting for designs and GIT/SVN shared repo.
Localisation (Rosetta release): More Rosetta sites got HelpHub activated. We are waiting for #meta team to import original HelpHub content. @audrasjb is going to open Trac ticket to hide automatic link to forums for locales that don’t use forums at .org.
Common APIs
@leogermani is proposing moving all documentation on internationalizing API and localising WordPress core, themes and plugins to newly published Common APIs Handbook. He will try to create all the necessary pages this week. After review the old pages from other Handbooks and Codex can be redirected.
Next meeting will have focus on Docs Team Handbook. Everyone are invited to review their parts of Handbook and indicate things that are missing or are out of date. A plan on adding/fixing these should also be made.
What is my part of Handbook?
Every project has its part in Handbook. You know the best how to contribute to project(s) you are involved with and, therefore, you know better than the others if Handbook is complete and up to date for that specific project.
The team page is mapping responsibilities and will be used as general guide for Handbook parts ownership. If you are missing from the list or your responsibilities have changed since Team page was created, do let us know and we’ll fix it. Or you can fix it yourself.
Next meeting will be run by @felipeelia and will happen on
This post is a starting point to discuss how we can organize the documentation around Internationalization and Localization on the new Common APIs Handbook.
Common APIs Handbook is the new home for documentation on APIs used across WordPress that is not specific to themes, plugins or any other component. There you will find docs on Options API, Shortcode API, etc. (Note that content is still being migrated so there might be incomplete pages).
This should also be the home for the i18n and l10n documentation. So let’s see how this could look:
Current documentation
Here is a list of the current documentation on this topic we have (and that I could found)
You will notice that we have duplicated content on these pages. “How to internationalize…” pages are very similar, with small differences in how to initialize text domains and where to save the files. “Localization” pages are pretty much the same.
Finally, we have the documentation on the new Javascript support for i18n introduced last year. This didn’t make it to the Docs yet:
Create an “Internationalization API” page on the Commons APIs Handbook with content from the current Codex page and the “How to Internationalize your theme/plugin” pages.
These pages already have the same content
Make sure to make it generic, in a way it works for themes, plugins, and the core
Redirect Codex page to this newly created page
Edit “How to Internationalize your theme/plugin” pages, leaving only plugins/themes specific information, and then linking to the “Internationalization API” page for general guidelines
Add to the “Internationalization API” page the section about i18n support in javascript. If we have permission, Pascal’s post could be incorporated.
Finally, we have to find a home for the “Localization” page. This is not properly an API, so maybe it could be an article on https://wordpress.org/support/ and all i18n pages could link to it
