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.
For this year’s GSoD, the WordPress doc team has to wait till April 16, to know if WordPress is selected as an org this year.
Open Floor/Q&A
@estelaris mentioned that during the project updates, there is a new post about the revision of documentation article is part of the Help Hub redesign series,
For the contents side, there are no updates for now. @atachibana will fix the check logs issues.
@estelaris is working on reviewing the list of articles. She is also have a 15 min call with matt & Josepha during Q2 Listening Hours to discuss about making documentation better
The doc team has 2 people who are interested in mentoring and no project ideas yet. The doc team is requesting to comment on the posts if anyone has any project idea. Also, the team is coordinating everything about the program on this 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/repo. The deadline for organizations is March 26 and project ideas are required for the proposal.
Update from @estelaris – There are no updates on the HelpHub redesign project yet but estelaris still need help with articles link review. All the articles must be reviewed, most are fine and few are not, and those few are the cause of plenty of fix-link requests. If anyone wants to review, 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.”@estelaris. The task is only to identify the wrong links and there is a team in charge of approving and updating the links. @ashiquzzaman showed interest to review the articles
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 Developer Doc
Update from @justinahinon – The table of content pull request (https://github.com/WordPress/gutenberg/pull/28665) is ready to be merged.
End User Block Editor team
Update from @bph – @geheren and Mathew McCabe had their sprint; @poena had also participated. Discussed the end-user documentation for Full Site Editing. The plan is to wait until the Prototype is released, and then again until 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. of 5.8 to see what will make it into coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress.. WP 5.7 changes are now available in our Spreadsheet and 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.
The team is also getting ready to touch almost all pages to implement More Options link/page enable comments and add a note to the change-log as with which WordPress version a page is currently. @Geheren added that to all the pages in the Trello board. Once @collinsmbaka publishes his page, all contributors can start working on it. A plan is in place to welcome new contributors to the team.
Full Site Editing Documentation
Skipped for this meeting.
Codex to HelpHub MigrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies.
@atachibana was unavailable to provide an update on this.
New Member Monitoring
@chaion07 reported that 10 new members joined the Docs channel in the past 7 days. The team welcomed all of them. Here is the Slack thread with the list of members.
@chaion07 reported that there have been a total of 5 contributors joining in for February 2021 Coffee Break. Thanks to @thisisyeasin, @Gtarafdarr, @atiktonmoy & @reachmazharul for making time. For those who couldn’t make it you can definitely join the March Coffee Break. Anyone who is willing to host it can ping either @chaion07 or @sukafia
Google Season of Docs
Update from @tacitonic: Completed 15/28 articles in the Word list and usage dictionary. Parser will be completed by Monday, i.e. today. The project finalization phase for Google Season of Docs begins from today. He’ll start writing a P2P2P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. on make.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//docs after the final project report. Google Season of Docs 2021: The organization application phase has also begun for this year’s program.
Open Floor
The team discussed using 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/ as opposed to other tools, as GitHub would also reduce the use of Trello to some extent.
The February Coffee Break took place on the 24th instant at 11 AM UTC timing which saw the presence of 5 contributors from the Global Documentation Team. Kudos to @chaion07 for hosting!
Docs Team Coffee Break for February 2020
I came online at the scheduled time but did not see anyone joining. So I waited and sent a message across my workplace, weDevs which resulted in a few of my colleagues joining instantly.
We mostly talked about how to become a Documentation Contributor and what projects are there to contribute. I tried to answer various questions ranging from the Handbook to the weekly meeting. All contributors were encouraged to attend the weekly meetings.
A few snaps from the coffee break
We thank @atiktonmoy, @thisisyeasin, @reachmazharul & @gtarafdarr for joining the Docs Team Coffee Break. We invite all of you to join the coffee break for March 2021 as it progresses from planning to execution.
@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 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.
Thanks to @justinahinon for facilitating the meeting
Note Taker and Next Meeting facilitator
Agenda: https://make.wordpress.org/docs/?p=11003
Notetaker: @collinsmbaka
Facilitator for the next meeting: @chaion07
Next Meeting: 25 January 2021
Find the complete Transcript of the meeting on Slack
Project Updates
@atachibana reported that the 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.: 285 of 355 (80.3% from 78.3%). Big Thanks to @stevenlinx as always.
@justinahinon reported on 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/ developer documentation restructuring project. He reported that they are working on the handbook homepage, which is in good progress and the new version will be done in the next few days. @PaalJoachim also reported on the work being done to improve the local development environment for docs with @johnbillion and @justinahinon. he shared a drafted update and his plans to further discuss with the coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress. dev team on 20th of January 2021.
@tacitonic reported his update for the Style Guide as follows;
I finished the Linking section this week – except for the External Linking document. That is on hold until the policy is finalized.
I encourage team members to review and discuss articles in the discussion tab on the repo.
@estelaris reported on her work on the documentation redesign; she shared a list of what she has done so far.
Monthly Coffee Break for January 2021
The date for this month’s Coffee Break has not been officially fixed and announced but should fall in on the 28th of January, 2021.
Open floor
@estelaris has been following up on the redirect links and mentioned that @sergeybiryukov is going to try to fix it for 5.7 as it needs to be fixed in core. Here is the link to the update
@chaion07 mentioned he isn’t sure but would 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.” the #meta team for the weekly meetings calendar to be updated.
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 by @themiked: Minimal changes, need to ratify the external linking policy document. According to Mike, all previous owners have just made changes as appropriate without asking, and nobody noticed.
Design for Documentation by @estelaris: Planning on finishing the design for documentation in the first quarter. Need to gather the final results from the reclassification project, other requirements I picked up from diverse meetings and put together my recommendation for final design. You will see a few discussion posts before the design proposal, aimed between the last week of March- first week of April.
BEE-Docs by @bph: Caught up on our articles to make them current with 5.5 and started working on 5.6 updates and create new pages. Started to open up the feedback for more pages. Definitely need instructions, how we would like to handle things. The team is now working via 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., Google Docs. Kudos to all who keep working away on the to-do lists. The ‘Thanksgiving Sprint’ which was a great way to get a lot of things done and connect with contributors, especially new ones. This will definitely be repeated and hopefully can be an ongoing team exercise. Kudos to @geheren for taking up a quite a few pages and work on them.Challenges: We don’t yet have a fluid system on keeping pace with the rapid development of 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/ and for adoption of FSE for 2021 the team needs help from the coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress.-editor team to at least have a rough draft of documentation coming from the developers, that we can follow and extend for End-User.
External Linking Policy by @milana_cap: Finally made some visible progress even though it was rather slow at the beginning
Google Season of Docs by @estelaris: One project finished and another is due to finish by Q1 2021 by @tacitonic. He finished the lengthiest section in the style guide – the Formatting section, started writing a spinoff section on Linking and encouraged team members to review and discuss articles in discussion tab 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/.
It’s Birgit’s first year on the team, so she’s not sure what’s the ‘usual’ process is. On Community team, there is a post asking for suggestions from the whole community, like the wishlist for the new release and then the team organizes the suggestions and translate them to goal statements, and picks their priorities.
Estela points out the goals for Design: Documentation design proposal – Q1
P2P2P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. new requests – Week 03
P2 new classification – Week 05
P2 on final navigation – Week 07
P2 on templates draft – Week 10
P2 proposal new design for documentation – Week 13
Open Floor
@estelaris feared to collaborate with the #meta team but at the same time is planning to annoy them until they reply. @bph mentioned that #Meta team is working on a Pattern Directory that is exciting for a lot of us.
@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 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 shared that contents team are migrating and re-routing Codex to Code Reference, and for this week the progress are: 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.: 199 of 355 (56.1% ← 43.1%) by @stevenlinx and @collinsmbaka as always. Akira is also working on removing duplicated method information in class references.
@milana_cap called for attention on this post related to the first review of the 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. Please read and add your feedback in the post comments.
@justinahinon mentioned that he posted the recap as well as the recording of the meeting about 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 restructuring. The post also contains the next steps to move forward on the project.
@bph shared that all tasks are assigned for the WordPress 5.6 update (released on December 08), and that the team working on them.
New Member Mentoring
@tacitonic shared that 6 people have joined the docs channel on SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. since the previous meeting.
Monthly Coffee Break
The team is still planning this month coffee break. If you want to facilitate or participate, please leave a comment on this post.
New Meeting Times and Holiday Planning for Docs Team
@dmivelli mentioned that her works on Google Season of Docs is officially done. She completed the project report and is now working on the evaluations. She is also planning to review pillars and categorizations starting next week and will provide updates in upcoming meeting project updates section.
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
This comment by @tbenyons about the documentation about the use of GPL within the WordPress project was brought to the attention. @themiked is reaching out to @ipstenu to have more information about WordPress project legal contacts.
@bph is planning to do a guided documentation sprint for the BEE-Docs starting this Wednesday through Friday (25 to 28 November). The extensive list of the changes in WordPress 5.6 that needs to be triaged and categorized, compared to the current pages and transformed into a contributor task list. Birgit will be online every morning 9 to noon EST. Please join her at your convenience during these times and contribute to BEE-Docs. Birgit will be posting an announcement p2 later on.
@justinahinon is collaborating with @paaljoachim 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/ Developer Documentation in order to improve it. Justin hinted that there might be a bit more progress than the past weeks.
New Member Mentoring
6 new members joined #docs in the week between 16 and 23 November 2020. Thanks to @prubhtej for the information.
Meeting Times
Due to the general confusion with the time-zones a new Doodle was created by @kenshino. Everyone is requested to cast their votes.
Monthly Coffee Break
The November Coffee Break was hosted by @estelaris with 5 participants joining. @chaion07 will be posting a summary in a p2 later on.
@estelaris mentioned that the classification project will start reviewing the 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. articles and coordinate with the BEE-docs team to figure out how to move forward.
The GSoD team would love to hear from the Docs team on the Do’s and Dont’s including comments related to the Style and Tone section.
Open Floor
@bph informed everyone that we need to enable discussion per page since the feedback section that’s now available on HelpHub. Users will be able to leave comments for the Admins and Moderators to be able to view them using wp-admin. Also in the works is a way to revise an article without taking the existing page offline or update unfinished. We will be able to work on 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. and then schedule making them public.
@paaljoachim asked if there been any talk about going through the structure of the handbooks and suggested that creating a flow chart of how docs are linked together can help improve on the user experience. @estelaris mentioned that there has been discussion on this in the past and advised everyone that any idea or a proposal on the topic is welcome. Paal will be bringing this topic next week since majority of the team is unavailable for this meeting.
-docs update