Welcome to the official home of the WordPress documentation team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the Codex (moving to HelpHub and DevHub), handbooks, parts of developer.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/, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
There are many ways in which you can help the Docs team. Every small contribution counts and helps! You can report an issue or typo you found in the docs, or even help us write new documentation for parts that are still missing. These are some helpful links to find out more about what we do and how to collaborate:
Block Editor Handbook: An overview of documentation contributions of 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. Editor / 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/
Documentation Issue Tracker on GitHub: Submit any DevHub/HelpHub/”Doc Team Handbook” Docs-related issue on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can 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.
For a few weeks now Documentation team is testing out new workflow for reporting issues – a GitHub repository which will be a single, centralised place for reporting all documentation issues. How and why we decided to do this can be found in team’s meeting notes.
What we hope to achieve with this workflow:
Easier contribution in form of reporting issues – even though this workflow still requires another account from contributor (the GitHubGitHubGitHub is a website that offers online implementation of git repositories that can 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/ one), with this workflow contributor doesn’t need to know which part of documentation is issue for. They can just report the issue and move on, if they so wish. We lost many one-time contributions due to the complicated workflow for reporting issues.
Easier contribution in form of fixing issues – with all projects and their different reporting issues tools, contributor who wanted to join team and work on fixing issues had to decide which project they wanted to work on before even seeing issues. With everything in one place they can browse all the issues, find the ones that seem interesting and then look for advice on fixing it.
Some projects didn’t have any way for reporting issues except for coming to #docsSlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel and hoping that someone will see it. This way is deprived of a place where the issue would be discussed as many things get lost in Slack noise. Also, this way is almost impossible to keep track of contributors and give them credits for their contributions.
Easier managing of projects and documentation in whole – team members have better overview of everything that’s happening in every Docs project, can help out in projects they usually don’t work on and have a general picture of WordPress documentation as a whole.
Easier contributions tracking – with every issue, comment, contribution being saved in one place, we have a better understanding of how certain parts of docs were created and who worked on them.
Better planning and setting goals with GitHub projects.
Better understating and following progress and statistics for each project by structured labeling system.
GitHub issue discussion
We are still configuring labels, templates and the repo itself; and still figuring out the best way to work on/with issues. For the future we hope to connect this repository with the actual documentation at 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/ so that contributions can be make directly on the page with the issue which would automatically create new issue and apply proper labels.
In the next phase, which will be soon, we will start using GitHub Projects for managing all the issues.
GitHub Projects board
Documentation Team is managing all documentation as an unified project and is adopting appropriate tools in order to do so.
As always, if you have any questions or suggestions, please leave the in comments bellow.
Next Meeting Facilitator: No volunteers found for facilitation of next weeks meeting. Volunteer over #docsSlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. if you can do this.
Project Updates
Proposal Update: An audit tool for Learn
Update provided from @courane01. No deadline set at the moment. Proposal gaining interest from team leaders, Learn/Training team will see a few new contributors from Automattic. Importance of streamlining auditing for teams mentioned, new Instructional Designers that are on-boarding at Learn.
Discussion about revision management and the importance of tracking changes. Some questions from facilitator @milana_cap about existing tools used in editing workflow.
Plans to continue collaboration between #docs and #train on this proposal, to set to write up docs needs in two weeks time, and have a video chat to discuss further.
5.8 Release
Today we’re entering betaBetaA pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. 3 phase.
By the next Tuesday (when RC1 is starting) we’ll have all dev notes and field guide published
After that we start working on DevHub and HelpHub updates
Volunteers: anyone wants to help with DevHub, pingPingThe act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.”@milana_cap over Slack #docs.
@atachibana shares that 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. Japan 2021 there were many new contributions, one team is creating an end-user manual. Reference link https://jawordpressorg.github.io/user-manual/1_login/.
@chaion07 is focused on onboarding new members. Meeting will be set later this week for new members, details posted later on P2P2P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/..
Docs #docs team is actively looking for new members and a new 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. Editor End User Docs Project Lead. Block Editor End User Docs behind by 2 releases. For reference on this project see TrelloTrelloProject management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. board at https://trello.com/b/JnTCzOsL/gutenberg-end-user-docs.
@femKreations is continuing work on the Site Health docs.
@courane01 presented the proposal for an audit tool from the #training and LearnWP team and asked the #docs team to think about what would help in revision control that could work inside a .org site? What would help our workflows more?
It is important to have revision control features but also more granular ways of tracking entire articles, images, videos, etc. that make it a low-lift for short term contribution work.
We are looking for 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. Editor End User Docs Project Lead. Let @milana_cap know if you are interested.
Open Floor
@webcommsat thanked everyone who participated in WCEU this year.
We discussed this lightly in a team meeting 1.5 weeks ago but we did not managed to put this into writing.
I have recommended that @milana_cap and @atachibana become Docs’ Team Co-Leads alongside me. They’ve been doing some great work over the last 2 years and have really stepped up in the the team’s leadership and project management aspects.
If there are no objections, we’ll solidify this decision by 28 29 March 2021 (in our Docs team meeting).
Feel free to reach out to me on #docs or via DM if you have questions!
@themiked reported that 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 Handbook goals are done.
@milana_cap suggested that all reps for different projects make sure that their projects are added in the Team Goals for Q1 2021 document. This should become a regular practice to have goals listed in our handbook as it’s easier to keep track with projects and contributors can see the progress.
@estelaris updated her project goals and will have and will have the first post ready for review before publishing.
Obsolete P2P2P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. Docs: @themiked suggested that obsolete P2 docs will stay in their place, wrapped with something to indicate their absoluteness. To use the red Warning box short-code along with some phrasing that everyone will then want to modify, but it’s easier to edit than create so that’ll move things along faster.
User Notes: @cstauf mentioned that before the weekend there were no pending user notes. There are however 16 entries for feedback to docs changes that @audrasjb has indicated that he will handle.
Migrating from Codex to HelpHub: Content team is migrating and re-routing Codex to Code Reference HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same.. 296 out of 355 are completed (83.4% from 80.3% from last week). He thanked @stevenlinx like always.
BEE-Docs: @bph posted an update asynchronous to the meeting that the team is making headway page updates after 5.6 release Thanks to @cguntur@bizanimesh@geheren@collinsmbaka. She also thanked @incapit, Tom Rankin and @MathewMcCabe for joining the team and collaborating on updates.
New pages needed 6
WordPress 5.6 44
WordPress 5.5 14
WordPress 5.4 3
WordPress 5.3 2
WordPress 5.0 9
Pre WordPress 5.0 3
The will schedule a team sprint for the first week in February to discuss task list for 5.7 @geheren and I are working on triaging the issues 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/ Changelogs 9.3 – 9.9
Figure: BEE-Docs Update
New Member Mentoring
7 new members joined #docs in the week between 16 and 23 November 2020. The mentoring team is contacting the new members. The process is a little slow due to the unavailability of many members who are still not back from their holidays and we can definitely understand that. The mentoring team continues to maintain the process and always appreciate the new members who respond to our messages. Thanks to @chaion7 for the information. He also thanked @sukafia, @tacitonic, @Prubhtej_9, @tomf @MathewMcCabe for continuing the good work.
Monthly Coffee Break Announcement (January 2021)
The first coffee break for 2021 is set to take place on the 28th of January.
@chaion07 will be hosting this coffee break at 3 PM UTC. Details to be posted in P2.
The only other section remaining is the A-Z word list/Glossary.
Encouraged team members to review and discuss articles in the discussion tab on the repo.
@tacitonic mentioned that as the project deadline is approaching, it would be great if we could get the GitHubGitHubGitHub is a website that offers online implementation of git repositories that can 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/ to WP Org parser implemented, which would give me some time to work with errors/issues if any.
@atachibana reported that the contents team continued migrating and re-routing Codex to Code Reference, and in this week we processed: HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same.: 224 of 355 (63.1 % from 56.1% the last week) by @stevenlinx and @Mathew McCabe
External Linking Policy – there was a lack of input from the team on the post but we have a deadline so for the first review of 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 Developer Handbook we have two reviewers (even though we are aiming for 3) – @themiked and myself. I’ve already done the one for “undoubtedly allowed” links. @themiked please do yours this week if you can so that we can start applying results and keep the deadline by the end of this year.
GSoD Documentation Style Guide – I’m working on manifest.jsonJSONJSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. file which is needed for parsing GitHubGitHubGitHub is a website that offers online implementation of git repositories that can 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/ markdown files to our very new Style Guide Handbook. Once I finish it, I’ll pingPingThe act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” some good people from 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. to run it for the first time. Really looking forward to seeing this one.
We are asking all #docs team members to read the above post about External Linking Policy. We need your decisions and votes. As it is now, this will be a “two persons” decision.
-docs update We have still three orphan pages on our to-do-list for 5.6
Updates: Image 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. page
new page: Image Editing features
Updates to Latest Posts
New contributor @incapit works on their first page.
Another new contributor will be on-boarded this week.
After some discussion, we decided to skip the coffee break this month as it is too tight between the holidays and the State of the WordState of the WordThis is the annual report given by Matt Mullenweg, founder of WordPress at WordCamp US. It looks at what we’ve done, what we’re doing, and the future of WordPress. https://wordpress.tv/tag/state-of-the-word/..
Discussion: Clarification about the use of GPLGPLGPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. by WordPress plugins and themes
There was a discussion previous to the meeting on Slack. The conclusion is to point docs to the license page. @themiked clarified that the license question asked a few weeks back was mashed out and the license page for the plugin handbook was updated to include a link to the general WP license page and suggested the same approach is taken for the theme handbook.
@atachibana mentioned that the contents team is migrating and re-routing Codex to Code Reference, and in this week we processed: HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same.: 171 of 355 (48.2% from 43.1% the last week) by @stevenlinx. Thank you. He is also removing duplicated method information in class references.
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. editor end user docs team
– docs team update was given by @bph There was a team sprint ( here is the Announcement) I was joined by four docs team members throughout the days for short period of times or asynchronously.
Please welcome our newest contributor @Michael Geheren. Also, Chandrika Guntur @cguntur, Ahmed @chaion07, and Estela Rueda @estelaris. We published/updated five pages, demo’d the publishing process and how to use the BetaBetaA pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. Tester 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 (Videos are to come). We also noticed a few inconsistencies and recorded them on GitHub.Throughout the three days, we identified 21 pages that need updates for WordPress 5.6. They are all listed in the TrelloTrelloProject management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. board >Needed Changes/ New Pages column. The list is also available in the Google Spreadsheet > Experienced Contributors 5.6 Tab. The source of Truth is the Trello board, though. I documented my process in posts to the Slack channel and will create a Google Doc with the steps for review by the team. @estelaris walked us through the current stages of Google Summer of Docs project on categorization and discoverability as it concerns the Block Editor End User documentation. It was a very enlightening conversation and it was great to see more people join. This was also recorded. Next Steps:
Finishing up the videos
Reaching out to contributors to discuss their availability for these updates and
Finish identifying update tasks.
Stats for the block editor end user documentation
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/ developer documentation
6 new members joined #docs in the week between 23 and 30 November 2020.
Monthly coffee break
Thanks to everyone who joined November’s coffee break. If anyone is interested to host the next coffee break then please let us know. We will share the date, time, and other details very soon.
The docs team has chosen to change the time for the weekly meeting to 14.00 hrs UTC. There will be a post to make it official later this week.
Holiday schedule
The #docs team will take a holiday break from 14 December to 11 January and there will not be any weekly meetings. Yet, the channel is still open for those that want to continue contributing but we recommend that everyone takes a break.
I completed the review of the block editor articles and posted my title recommendations for review and approval. I will review the pillars and categorizations in the next two weeks. GSODs now entered the phase where I must complete my project report summarizing the results of my GSODs project.
Discussion: Structure of the handbooks
@paaljoachim is working on an idea to add all the support handbooks into one landing page. The idea is that there is too much documentation spread around making it hard to locate. He would like to present a better structure for documentation. If anyone has any comments, please add them below.
Open floor
@sukafia proposed to make the last call a Zoom call. If you would like to participate, please add your comment below or join next week’s meeting for more information.
@paaljoachim proposed to add the “public post preview” to the docs blog to help team review posts. @estelaris will add a 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. ticket for this.
MigrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. from Codex to Code Reference: @stevenlinkx and @collinsmbaka continued migrating and re-routing Codex to Code Reference: HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same. 124 of 355 (34.9% < – 30.4%). @atachibana edited each method of information of the class references. @dd32 added a redirect to every page. No change in 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 handbook until the external linking and the obsolete docs gets resolved.
Meeting Times
Due to the general confusion with the time-zones on the current Doodle, @kenshino will create a new Doodle and @crs1138 will notify all contributors who already voted on the original Doodle about the need to vote again.
New Member Mentoring
There are 5 new members joining #docs in the week between 2 and 9 November 2020.
Monthly coffee break (November 2020)
@estelaris will run the next monthly coffee break which will be on the Thursday 19 November 2020. The time for the coffee break should be Asia friendly and will be specified later on.
@tacitonic is currently working on the Punctuation section and updates the progress in the README file on the daily bases.
@dmivelli has finished reviewing the discoverability project and submitted a long list of typos and grammar errors that @estelaris will be fixing this week. There are also many titles that must be changed.
Docs Handbook and facilitating collaboration
@leogermani and @themiked rewrote a couple of pages but there is still more work to be done. As an example @leogermani pointed out the Projects page that could reflect more precisely what’s going on in their team. They also worked on the Workflow page. @leogermani suggests an idea to add a “report an issue” button to the pages to make it easier for people who want to collaborate to find their way.
@bph posted an update asynchronous to the meeting.
The team will be working on the “Sprint for BEE-docs” during November 25 – 27, 2020. Details will follow. If interested, please leave a comment on the digital check-in post.
@atachibana informed about adding dropped information of Codex to code Reference and re-routing:
HooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same.: 108 of 355 (30.4% < – 25.4%)
He also spoke on editing method information of each class’ references.
The team is still awaiting responses to the Doodle link from everyone for the meeting time as many parts of the world have already begun adjusting to the Daylight Saving Times. Please cast your preferences using the Doodle link.
New Member Mentoring
@tacitonic informed the team that we didn’t have any new member joining #docs this week.
Monthly Coffee Break
7 people joined in the Monthly Coffee Break for October2020 with an EU-friendly timing. A few snaps from the meeting were shared with the team. Thanks to @sukafia for facilitating it including @tacitonic, @crs1138, @chaion07, @thisisyeasin and others who joined.
The next Coffee Break will take place on the 26th of November (tentative). More info will be shared as we draw closer to the date. Please pingPingThe act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.”@sukafia or @chaion07 if you require further assistance.
Google Season of Docs
@tacitonic & @diana did not have anything new to add for this week.
@estelaris suggested that a meeting is scheduled for everyone involved in the GSoD project to take part in.
-docs update