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 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.
@valentinbora to post DevHub migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. cross-check code to 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/ [update: done]
@milana_cap to update workflow for facilitating a meeting by including a step to review prior meeting notes
@milana_cap@kenshino to confirm usage of CrowdSignal or another service for hosting the survey
@atachibana to coordinate survey review before it goes live
@leogermani to review and update the Handbook and welcome box to attract new contributors
@leogermani to reach out to the #meta team to ask for stats to help highlight how important, popular and relevant docs are, as well as stats to support the survey (most viewed pages, devices used, referrals, searches etc.)
@valentinbora updated the team about a quick tool he’s written to cross-check migration status for Functions as he found quite a few pages out of sync in the Sheet vs. their actual live status. Before automated corrections there were 480/1069 Functions done (44.9%), after corrections we’ve won some and lost some, tallying to 374/1069 (35%)
@leogermani reminded everyone that the purpose of the survey is to learn: “How complete is our documentation and how can we improve our user docs?”
@themiked considered the survey to be asking some questions that could be inferred by statistics instead
@mkaz asked whether the survey was to be taken from a user’s or a developer’s standpoint. @leogermani clarified that it’s both
@themiked mentioned that the question “How complete is our documentation” is a difficult one to answer for end-users but we could still give it a try
@leogermani encouraged feedback for the survey to go to the p2 post linked above in order to have it all in one place but would like to hear from @bph in terms of the roadmap for the survey, with WordCamp Asia in mind.
Comments for the survey should be added by February 12th in order to prepare the survey well enough in advance before 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. Asia happening on February 21st, 2020.
@mkaz considers open ended questions to be difficult for end-users to answer and is wondering whether end-users get their answers from official documentation or elsewhere
@bph, @leogermani, @milana_cap discussed where to publish the survey, be it CrowdSignal or Pollbuddy vs. Google Forms. @kenshino should have something to say about that
@kenshino@milana_cap agreed to first focus on gathering the right questions to survey for before February 12th
@leogermani would like to attract more people to contribute to Docs and wants to review the Welcome box on the handbook page and bring documentation up to date to make it easier for newcomers.
@atachibana mentioned @estelaris‘ suggestion to reorganize the documentation tree with categories and subcategories.
@valentinbora suggested reviewing barriers to entry alongside motivational efforts for new contributors
@kenshino suggested to simplify the docs badge tracking Sheet to just two tabs. Any project leads can add contributors and they’ll be awarded a badge without question.
Open Floor
@valentinbora posted some tickets regarding DevHub and Explanation post types to help with Codex to DevHub migration (see more)
@leogermani@milana_cap mentioned @netweb was working on making it easier for setting up a local HelpHub environment for new code contributors to join in
@sukafia would like to know how to suggest edits to the HelpHub (user documentation) and @milana_cap suggested to ask in the #docs channel directly on Slack
@felipeloureirosantos posted an update regarding Brazilian Portuguese (pt_BR) docs. They have 5 new translated pages, 1 page in progress and a new contributor over the past week
@leogermani and @valentinbora conferred about the migration process, specifically that there’s little room for automation regarding redirection, but the redirect itself could be taken care of by an automated script once marked Ready for redirect
