Welcome to the official home of the WordPress Documentation Team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.
Want to get involved?
Start here to find out more about what we do and how to contribute:
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Weekly meetings
Join our discussions of documentation issues here on the blog and on Slack.
The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Any one may join who wishes to contribute to the team and who follows the Code of Conduct.
Please also see Contributor Day — 23 May, 2023 on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ for onboarding and other important details.
Onboarding on Zoom
In addition to the details in the GitHub issue for this Contributor Day, folks who are in need of onboarding can ask in SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. or on the Zoom call. In Zoom, a breakout room will be started where contributors can be onboarded.
If at any time you have any questions, please feel free to ask in the #docs channel on Slack or in Zoom throughout the day.
Your WordPress.orgWordPress.orgThe community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ profile username
What you worked on and include links when possible.
Or, just comment anything (such as your WordPress.org username) to let the team know you attended.
The next Docs Team Contributor Day is May 23, 2023 from 1 PM UTC to 4 PM UTC.
Open floor
@milana_cap asked if there was any feedback from our last Contributor Day.
@ninianepress suggested breakout rooms in Zoom so that contributors who need it can be onboarded. At the next contributor meeting, we will ask if any one is in need of onboarding, then open a breakout room, as needed.
The team decided to continue with a 3-hour long Contributor Day and that the fifth Tuesday in May will be a triage meeting, following the week after our next Contributor Day.
These contributor days would be three hours long each,
they would be facilitated by any one and every contributor in attendance who wants to do it including team reps, leads, and other key contributors who are able to facilitate,
a Zoom link will be made available for contributors to meet as well as the #docs Make WordPress SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel,
the contributor day would be announced,
an issue would be opened in GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ with onboarding details similar to the first iteration, and
contributors who attend need to comment on the GitHub post with the tasks they will work on during the allotted time or else note that they are in attendance.
New monthly structure to bi-weekly meetings
In the meeting previously mentioned, the docs team agreed upon a new monthly structure that would incorporate the monthly contributor day.
Previously, there was an ongoing rotation of the team and triage meetings week-by-week so that each worked out to be a bi-weekly meeting in Slack.
The new structure for these two docs team meetings are as follows:
Week one: Docs Team meeting
Week two: Triage meeting
Week three: Docs Team meeting
Week four: Online Contributor Day
Week five: If there is a fifth week in the month, the docs team will have an extra week to catch up or it will be a triage meeting, as needed.
Please note: Week five is sometimes referred to as the “overeating” week by docs team contributors. It’s in reference to team meetings and the first online Docs Team Contributor Day where it’s common for kudos to be given when issues are noted by contributors as being completed by them. Kudos is often given in the form of 🍪 (cookie) emojis. Cookies and other desserts are sometimes also offered at the Docs Team table of the Contributor Day for in-person WordCamps.
The next Docs Team Contributor Day
The first monthly online Docs Team Contributor Day will be:
Please also check out Contributor Day – 25th April, 2023 on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ for onboarding and other details.
If you plan on attending and also on the day, be sure to comment on the GitHub issue with:
Two options for including the mobile app documentation include:
Create one categoryCategoryThe 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging.mobile app and all the topics as subcategory
Add each article inside the categories/subcategories we have now
The first option to create a new category was the final team decision.
During the recategorization of the documentation, the team removed several articles that were developer-focused or included a lot of developer-jargon. All these articles are now part of the Advanced Administration Handbook and will be removed from /documentation/devhub/.
The redirects have been applied as indicated in issue #59. Some articles have been merged to provide better explanations. Although, the maintenance is still ongoing, most of the articles have been updated.
Please note: @ninianepress wrote this summary as @femkreations was unavailable due to other high-priority Documentation Team tasks, and will also write the next summary for similar reasons in place of @estelaris.
@femkreations added related tasks to the 6.2 Project Board in GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/:
@estelaris is presenting and discussing the new documentation sites (HelpHub and DevHub) in a recent WordCampWordCampWordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. and will work with the Spanish team.
@javiercasares has ideas on how to test/try out ways of translating.
@estelaris is working on figuring out if we can use the Inventory as a tracker for polyglots so they are aware when we upload new articles.
How to improve the Glossary in WordPress
Also, in terms of collaboration with the marketing team:
The idea is to replace the many glossaries in the handbooks and make sure we are using the same definition for matching terms.
Make teams should be in charge of updating and adding new glossary terms, as needed.
@chanthaboune is aware of this initiative and has requested to be updated so support can be provided.
Update on the Docs inventory
This part of the meeting was unintentionally missed so it will be added to the agenda for the next bi-weekly Docs Team meeting.
Open floor
@estelaris has already reached out to the MetaMetaMeta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. team, but asked if any one had suggestions on how to get a page listing for the Support Articles page in Spanish. There are currently no sitemaps on the Rosetta sites:
@javiercasares suggested an alternate solution if other options aren’t available: Creating a page with the link list by using an APIAPIAn API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways.. One currently exists, though, it’s empty.
Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it begins on March 26th and in North America Daylight Saving started on March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.
The Docs team needs your help to update and revise the End User Documentation (HelpHub) for the upcoming WordPress 6.2 release, expected on March 28, 2023.
You can find a list of all the tasks in the 6.2 project board in the Documentation’s repo on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/.
Mention in a comment on the GitHub issue you would like to work on and someone on the Docs team will assign it to you.
Once a task is assigned to you, the following two videos show how to help with updating the existing articles in End User Documentation (HelpHub).
Video onboarding to End User documentation Video showing how to help with updating the existing articles on GitHub
If you have questions or need help, ask in the docs channel on the Make WordPress SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. or directly in the GitHub issue itself. If your meetupMeetupAll local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. or firm can give a blockBlockBlock is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. of time to help, do include the Release co-leads for 6.2 documentation in your message: (Slack IDs) @bph, @zzap, @Femy, and @abhanonstopnewsuk.
Resources
If you need a test site with WordPress 6.2 pre-installed, you can use this app provided by InstaWP to spin up a new temporary website set. It is preloaded with Theme Test data and other pre-configuration, ready to go. This new site will be available to use for four hours. After that, if you need another test site to contribute to docs, you can visit the link again and create a new temporary site.
@leonnugraha worked on the Navigation block article during the WC Asia Contributor Day. Because it’s so outdated, it requires a new document once the WordPress v6.2 release candidateRelease CandidateA beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. is out. Work on this article will continue then.
@femkreations completed gardening the closed pull requests in GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ from 14.2 through 15.1, and added the “User Documentation” label.
@estelaris mentioned that the biggest ticket for the categorization project – moving technical articles to DevHub with issue #388 – is now closed. A big thank you goes out to @JavierCasares.
Discussion on application for Google Season of Docs
The discussion for a proposed application for the Google Season of Docs has been rescheduled to the next meeting.
Google has a program where you can apply as an open sourceOpen SourceOpen Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. project. If you get chosen, Google will help you with the project’s documentation.
In 2020, the Documentation Team participated, and our style guide was completed. We need to think of a good project in order to be chosen since the competition is high. @milana_cap is already making inquiries to see if we can participate again this year.
It’s important to note that the application process has changed so this will also need to be considered in future discussion.
@sereedmedia mentioned asynchronously that the glossary may be a great project to apply for and @estelaris agreed.
Open floor
@estelaris is meeting with the Polyglots TeamPolyglots TeamPolyglots Team is a group of multilingual translators who work on translating plugins, themes, documentation, and front-facing marketing copy. https://make.wordpress.org/polyglots/teams/. to discuss collaboration on documentation updates.
@femkreations completed reviewing the closed pull requests (PRs) in GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ for Gutenberg from 14.2 through 15.0, and the User Documentation label was added. Femy also reviewed and closed one WordPress 6.1 issue.
@estelaris posted #652 and #651, but it was later moved to the MetaMetaMeta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress.TracTracTrac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. Ticket #6740.
@JavierCasares mentioned two meta trac tickets – #6411 and #6714. Both need follow-ups and @milana_cap will leave a comment on the ticket for updates or ask about them in an upcoming meta meeting.
Props to @leonnugraha for writing this meeting summary.
@estelaris noted that @javiercasares (not in attendance) is the project lead for the Developer Handbook (DevHub, internally) redesign. She mentioned that the design has been finalized, and development work has begun.
@femkreations would also like to note that issue gardening for v6.2 is in progress from the GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ pull requests (PRs).
