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.
@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.
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.