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 — 28 November, 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.
@milana_cap had created 48 good first issues for WordPress 6.4 documentation and ran 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/ roles onboarding session. The recording is uploaded to wordpress.tv but not published yet.
@webcommsat gave an update on WordPress 6.4 release documentation:
(Update – link to full update in the meeting and how contributors can help, including working on or reviewing screenshots, video, new explanations. Highlighted the value of docs in this area to the end user.)
Dev notes: one additional dev note has been added to the Editor Miscellaneous Dev Notes today
There is one remaining Dev Note which will be done after the release by one of the committers
Call for contributors to work on HelpHub
Props for all those who had contributed by the beginning of last week have been collated, checked against the main list, and submitted
A further props update will be sent once the End User docs (HelpHub) have been updated
Ongoing outreach and promotion, particularly the HelpHub end user docs
Onboarding / support to cohort and additional volunteers
Following up work on End User docs.
@atachibana reviewed one issue #1204, and tackled high priority 6.4 issue #1204, the Site Editor Pattern.
@anandau14 worked on one high-priority task and has 2 more assigned.
Open Floor
@webcommsat raised from experience of the last couple of releases and involvement in CoreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress., Marketing, Docs, and Training, a resource to help meetups devote a session to helping with User docs would be very useful and raise awareness about docs. More on this suggestion, what has been started in 6.4, and the fuller discussion 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/.. (link to Slack discussion added)
The ideas included to get meetups and companies to sign-up to help earlier in the release cycle, show how fun it can be, and promote our contributor events.
@leonnugraha had reviewed, updated, and closed #1207. He had also reviewed and updated #491 but because there’s still one item needs to be done, so he has not closed the issue.
@femkreations had looked through approximately 150 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 (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/) that were labeled “Need User Documentation” and identified 34 tasks that need to be worked on, for 6.4 in the end-user documentation. She had also completed adding those tasks to this Project Board. The tasks were then divided into: High Priority, Medium Priority and Good First Issues. She also wrote a Call for Volunteers to help out with the update.
Open Floor
@milana_cap discussed about new GitHub roles i.e. issue coordinator and reviewer. Both of these roles could be performed by anyone, regardless the experience with docs or WordPress and which would require about 1 hour per week or may be less.
Issues Triage
This was the 5th week meeting which turned out to be a combination of the weekly triage and the regular weekly meeting. To look at the issues in WordPress 6.4 High Priority Issues click here.
1. Attendance. 2. Project check. 3. 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/ roles discussion (issue coordinator and reviewer). 4. Triage.
The Docs team needs your help to update and revise the End User Documentation (HelpHub) for the upcoming WordPress 6.4 release, expected on November 7, 2023.
You can find a list of all the tasks in the 6.4 project board in the Documentation repository 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/.
Add 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 introduction: contributing to End User documentation Video showing how to help with updating the existing articles on GitHub (this uses 6.2 as an example).
Once you complete the updates for the particular task, add a comment to the issue you were working on:
with a note on the changes you made
and tag the following contributors in the Docs team (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/. docs channel add ‘@’ before the ID: femy, LeonardusNugraha, or jenni)
a contributor from the Docs team will be able to review the updates and add the content to the article
If you have questions or need help, ask in the docs channel on the Make WordPress Slack 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., collective or organization 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, leave a comment on this post or send a message to the documentation channel on the Make WordPress Slack and include the Release co-leads for 6.4 documentation in your message: (add ‘@’ before the ID) @abhanonstopnewsuk, @Femy, @611shabnam.
Resources
If you need a test site with WordPress 6.4 pre-installed, you can use this app providedby InstaWP to spin up a new temporary website. It is preloaded with Theme Test data and other pre-configuration and is 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.
When revising already published content on HelpHub, you can use the RevisionsRevisionsThe WordPress revisions system stores a record of each saved draft or published update. The revision system allows you to see what changes were made in each revision by dragging a slider (or using the Next/Previous buttons). The display indicates what has changed in each revision. Extended pluginPluginA plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party that is already installed. Refer to the video: How we use the Revisions Extended plugin on Learn WordPress.
Where can I find other documentation on the 6.4 release?
The release group with other coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress. and doc contributors have been working on developer notes related to major features and changes in 6.4. The Field Guide for WordPress 6.4 is available and brings together the most important items. You can also view all dev notes via the 6.4 developer notes tag.
Props to @webcommsat for input into this post and its review.
Please note: Daylight Saving Time (DST) will end on Oct. 29 for Europe and Nov. 5 for North America; the date may differ depending on your location. However, the meeting times will remain the same at 2 PM UTC.
Project checks
@milana_cap mentioned that she went through all of the issues with documentation that didn’t have a label [Status]and added the appropriate label to them.
Triaging all the closed pull requests (PRs) for 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/ (GB) 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/ (GH) for 6.4 and labeled the required PRs with the “Needs User Documentation” label.
Created a 6.4 Documentation Project board from template #141.
Created two videos that show how the GB PRs are triaged for a release in a GH and how to find all the PRs labeled “Needs User Documentation” for each milestone.
Open floor
@leonnugraha volunteered to write and publish next week’s contributor day post and the corresponding GitHub issue.
@estelaris is planning on implementing a triage hour with the Spanish team, probably twice a month, to write and review the style guide. She is also reaching out to the Brazilian team that wants to start working on translations, and she’ll begin by creating a style guide in Portuguese.
Props to @rashiguptaa for writing this meeting summary. 🍪
The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Anyone may join who wishes to contribute to the team and who follows the Code of Conduct.
In addition to the details in the 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/ 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.
After Contributor Day
Other than celebrating with some 🍪🍪🍪 after Contributor Day is over, please also comment on the corresponding GitHub issue with:
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.
@611shabnam shared the progress of #678 and explained that she is working on the issue left.
@noumantech was so busy with projects he couldn’t focus on the #1100. He is committed to completing it in a couple of weeks. @pekkakortelainen shared the progress of #430 and provided details of the size of the revamp. It would take time to finish it. He also showed interest in addressing one of the notes from Sep 19th meeting: about onboarding new contributors.
Open Floor
@anandau14 will be leading the Documentation team table at 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. Bhopal Contributor DayContributor DayContributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. on Saturday (October 7, 2023). The Contributors Day can bring some new contributors to the channel
@webcommsa shared an update on the docs release for 6.4. She explained that avoid adding the Google folder to the public minutes, as two of the cohorts can not access Google Drive to update the documents in there so we have temporarily had to enable it to link access for editing until their access to Google Drive can be solved. She also referred to the statement of @cbringmann” Dev Chat recently, you do not have to be on the squad or in the cohort to get involved in an aspect of the release.”
@estelaris will be leading the docs team at Yoast Contributor Day tomorrow. Will focus on good first issues and the 6.3 task board. @anandau14 showed interest in the contribution to the docs release for 6.4. @webcommsa advised @anandau14 to participate in Yoast Contributor Day with @estelaris
The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Anyone may join who wishes to contribute to the team and who follows the Code of Conduct.
In addition to the details in the 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/ 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.
After Contributor Day
Other than celebrating with some 🍪🍪🍪 after Contributor Day is over, please also comment on the corresponding GitHub issue with:
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.
