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.
Meeting 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.
@chaion07 promised there will be a Doodle up soon with APAC-friendly options for choosing a day and time. He estimated that the next Coffee Break will happen in the last week of July.
Please feel welcome to suggest 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. in the comments.
@atachibana reported that for the migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of Codex to Code Reference for Functions, 1033 of 1070 (96.5% <- 95.5%) pages have been completed. He thanked @stevenlinx for the contribution with open tickets. He also mentioned that we have to wait until version 5.5 release and enhancement of document fixes to Code Reference for 100%.
@makewebbetter offered to volunteer for working on migrating 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..
@bph updated on the Bee-Docs (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):
@tacitonic has been reviewing posts with new contributors.
We are looking at WordPress.comWordPress.comAn online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ to fill gaps in 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/ documentation
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 finds more usage now that we have more team members on board.
@collinsmbaka will connect with the coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress.-editors regarding plans for Hulu and Photobucket embeds blocks, if they are abandoned or if we should file issues for them.
WordPress 5.5 is coming fast now. 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/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 versions 8.5 and lower will come to core. Including the import button for external images. So we can keep drafting and collaborating on Google Docs and copy/paste for publishing. The button appears on each image block, and just needs click to get the image into the media library of wordpress.org
Also shared 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 plugin with the team in case they want to do some peek preview. We’ll keep and eye out for the denotes, too.
good news/bad news: We ran out of tasks for new contributors:
Homework for next week for all: thinking about new tasks for new contributors early wins.
The Bee-Docs team meets each Monday at 14:00 UTC in the #meta-helphub channel over Slack.
@Prubhtej_9 reported that he completed the Scribd block editor documentation earlier that week & thanked @tacitonic for reviewing the doc.
@christiano.zanca reported that @glorialchemica started testing italian helphub translation. The Italian Team is providing support to this ticket to onboard more contributors.
Categorization Project
@estelaris reminded that we can still leave comments on the p2 post and this agenda item will be on hold until the finalization of Technical Writers for this project on the Season of Docs.
@bph suggested that we might need to review how block editor end user documentation is presented. It’s kind of buried, and probably needs a separate entrance and TOC.
External Linking Policy
We’ve witnessed vivid discussion on this agenda item.
Anyone with a WordPress.org username can propose the link (as equivalent to anyone with a WordPress.org account can edit Codex). We could have a Google form or airtable or something similar. They need to fill out following fields (all mandatory):
External link
Placement link at wp.org (where this external link should be added to)
Short description (why this link is a good fit)
WordPress.org username
Consent (“I read the external linking policy rules…” checkbox)
If the proposed domain name appears to not follow the rules 3 times, the domain name gets on the “banned” list.
Review Process:
To make the review process less confusing, we can prepare the set of questions to which all answers have to be “yes” in order to allow a link.
3 members of docs team completes a review (to avoid bias)
The review results are published on #docs team blog
domain name gets 5 links approved get the “trusted” status and we add them to the public list of trusted resources
If one allowed external link gets changed after being approved in a way that is against the rules, all links from that domain get removed, domain name loses its “trusted” status (with possibility to land on “banned” list perhaps?)
The Rules: (Brainstorming Ideas)
The content (article/tutorial) must not include any plugin, theme, service (hosting and similar) that is not bundled with WordPress clean install (which can be downloaded at WordPress.org)
The content, in its entirety or parts, must not be behind the payment or any sort of compensation from the reader (like, share etc)
The page where the content is can not contain visible ads for paid products and services (link in menu is OK but banners are not)
@kenshino suggested When people submit links, one of 2 things can happen
The link is added directly
The content is copied because it’s really good and they get attributed
The discussion centered from trusted links to commercial blogs, tutorials, promoting products, banners, attribution and even 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. licensing.
We request input from everyone. There are many aspects to policy making. Please join the conversation on the respective p2 post on commercial blogs and trusted sources.
New Member Mentor Training
@Prubhtej_9 reported that for the month of July 22 new members had joined & 13 new members had joined #docs in the past week.
Due to the unavailability of @sukafia & @tomf the discussion on #docs-help channel was postponed to next week.
Monthly coffee break
@chaion07 reported that he’s still in the process of writing a p2 post, which he had volunteered for. @sukafia is assisting with the p2 post.
Google Season of Docs
@Kenshino(jon) suggested that the ‘Documentation Team’ badge be given to the selected Technical Writers and Mentors for Google Season of Docs. He also mentioned that @ChloéBringmann along with the Mentors are finalizing the selection of the Technical Writers which needs to be reviewed by Google as well.
Open Floor
@tacitonic reported that @Lucila Stancatohad contacted him regarding the following matter:https://wordpress.slack.com/archives/C02RP4WU5/p1594123868113500
@chaion07 offered to make a specific Meeting Summary and Meeting Agenda Document Template in Google Docs so that anyone as a New Contributor can find a direct guideline to assist with the Note taking process & requested to write a p2 post for the same.
@kenshino(jon) also reported that he had shut down the wp-helphub.com server.
@atachibana informed on the MigrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. of Codex that 1022 out of 1070 pages had been completed. Currently the project is 95.5% completed which is a 0.70% improvement from last week. He also thanked @stevenlinx for processing complex cases with Open Tickets.
@christiano.zanca informed that the Italian team started translation of HelpHub. Currently Google Docs is being used as the base for checking and then publishing it.
@mkaz is continuing to work on theBlockBlockBlock 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. Tutorial. Currently working on the developer’s environment portion through PR 23953 and more.
@tacitonic currently reviewing The Bee-Docs tasks as @collibnsmbaka and @khushbu.desai are publishing the final drafts on embed blocks. The Bee-Docs Meetings are held every Mondays at 14:00 UTC in #meta-helphub under the supervision of @bph as always.
@Prubhtej_9 is contributing to the Scribd block editor documentation including a few of the handbooks this week & had a small discussion with the Rest APIREST APIThe REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. team regarding their inputs for improving the Rest API handbook.
Categorization Project
@estlaris reminds everyone that we are looking forward to comments on the p2 post that she wrote earlier. @milana_cap is looking into the comment left by @annezazu previously that focuses on the Github issue.
You can join the conversation by visiting the p2 post related to this topic. We are expecting input from everyone.
New Member Mentoring Team
@softservenet reported that the New Member Mentor Training Team met recently to discuss support capabilities for new members.
@sukafia reported that the Mentoring Team is actively reaching out and checking up on new members. The team is ensuring that every member gets a Welcome Message and is provided with links to helpful resources and guidance relevant to #docs. 7 new members have joined since last week, raising the numbers for this month to 75. The Team is considering to write a p2 post on the proposal for a dedicated channel on Making WordPress Slack so that this can be discussed with the #meta team.
@chaion07 is writing a p2 post covering the monthly summary piece (with the assistance of @sukafia). The new Doodle for the coffee break will be shared in the channel soon. Since it’s not Asian and some timezone friendly, we’ll have to be rotating the time. We will try to rotate the timing in such a manner to suit as many geo-location as possible to gain maximum audience.
Meeting 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.
Prior to the meeting, @atachibana reported 1006/1070 (94%) completed for the migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of Codex to Code Reference for Functions. He recognized @stevenlinx for their collaboration processing complex cases, and @obt28 for work on 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..
@bph completed the first meeting for 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. Editor End-User Documentation team. The team meets again next Monday (1400 UTC) in the #meta-helphub channel.
Categorization Project, Alterations Workflow
@estelaris has a draft post in-progress. She expects to finish it no later than Wednesday, and requested discussion and feedback as comments on the post.
External Linking Policy: Trusted Sources
@milana_cap authored a detailed post on this topic. She has been fielding questions, and this is helping to shape some early ideas about workflows. More participation is better. Everyone is invited to contribute ideas and questions as comments on the post. For updates, follow the #external-linking-policy tag.
New Member Mentor Training
@sukafia reported that 63 new members have joined the docs channel this month. The New Member Mentoring team has made follow up contact with all the new members. @sukafia thanked @tacitonic@Prubhtej, and @softservenet for their contributions to the team effort.
Monthly Coffee Breaks/Zoom Sessions
The June Coffee Break is set for this Thursday (June 25) at 1500 UTC.
Open Floor
@joyously referred to a question previously asked about the licensing “of the various docs: what is it and where is it stated”, inquiring if it was ever resolved or posted. @Kenshino answered that all docs in question were GPLv2, with permission to multi-license as-needed. He offered to create a page for the sake of clarity. The exchanges that followed weighed the merits of adding licensing content to post and page footers vs. creating a page.
@joyously is finding the new order of DevHub sections to be less useful than the prior version. She cited a closed ticket that resulted in the change. @Kenshino is pursuing a response from @atachibana.
Please feel welcome to suggest 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. in the comments.
Meeting 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.
@atachibana expressed thanks to all WCEU contributors, reporting more progress for the re-routing of Codex to Code Reference for Functions: now 987 of 1070 (92.2%) complete.
@bph extended a welcome to all new contributors to 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 documentation. Following a strong response from WCEU 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/., she is still catching up to reviewing new work. Half the work on the new contributor list has been published. The team also added more editors to make updates and correct errors. Going forward, she is transitioning team communication to the #meta-helphub channel.
@mkaz is seeking feedback for a draft version of the Create a Block tutorial in 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.
Categorization Project, Alterations Workflow, User Stories
@estelaris will write 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/. post on current journey mapping on documentation.
New Member Mentor Training
@Sunday plans to resume new contributor sessions next week, after a two week pause due to WCEU. @tomf reports that the mentoring team has been noting all the new docs team arrivals and has plans to reach out.
WCEU Contributor Day Wrap Up
This will come from @zzap who was not available for this week’s meeting.
Monthly Coffee Breaks/Zoom sessions
@chaion07 asked everyone to participate in @Sunday‘s Doodle (online poll) to help determine the best prospective meeting times. @tomf suggested that perhaps the meeting time should alternate monthly, if there isn’t a time that is practical for everyone.
Open Floor
Based on recent reporting about Instagram, @bph raised a copyright concern relating to the use of embed blocks. She asked for feedback for adding a general disclaimer to embed blocks’ documentation.
Please feel welcome to suggest meeting notes 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. in the comments.