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.
If you want to join the HelpHub editing tasks (Thank you!), there are some ways:
Proof Reading [good first contributor]
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/ document modification
Read HelpHub page and give us feedback. Any comments are welcome!
Read any pages under the https://wordpress.org/support -or- links of Column F “HelpHub Page URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org” of “List of Pages” tab in the spreadsheet.
If you find refinement points, technical errors, editing error etc., leave comment at the bottom of the page or 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.�? @Kenshino or @atachibana in SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. #docs channel. Any comments are welcome. For example:
Unclear or wrong description
Missing steps, URL links
Ancient screenshots
Ancient description (ex. WordPress 2.x, MySQLMySQLMySQL is a relational database management system. A database is a structured collection of data where content, configuration and other options are stored. https://www.mysql.com/. 4.1, etc.)
WordPress Version 5.0 introduced 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 (code name: Gutenberg) instead of the Classic Editor. We need new pages for block editor based on existing page that assumes classic editor. Please modify the contents based on the block editor.
To write/modify the pages under the https://wordpress.org/support, you have to get permission of write access. Send your 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/ account and e-mail address to @atachibana on Slack via direct message.
If you find more inconsistencies or discovered something else we should inform the other migrators; do let us know!
Default editor is Block Editor (Gutenberg). Some articles were made via the Classic Editor and so will present itself as one single Classic Block. You should use the Copy all Content function on the Staging site and paste it into the Production siteProduction SiteA production site is a live site online meant to be viewed by your visitors, as opposed to a site that is staged for development or testing.. You should then convert the article into actual blocks using the ‘Convert into Blocks’ function on the Production site.
When you copy and paste from the Codex, images remain linked to the Codex site. You should manually download images via the Codex site, and add to Media Library of the production site and replace the old contents. Note: Check Link Settings of the image. It might point original Codex image as “<a href=” tag. Change it to “Media File”
Use simple language – understanding is key! For instructional text: delete long narratives and change them to bullet or numbered list.
Use semantic headings: No <H1> in the article content – start sections with H2s and work down from there where appropriate.
Add screenshots where appropriate – if the article is describing any user interface element then it must include a screenshot.
[HelpHub Only, Not for Handbooks] Do not include https://wordpress.org when you make the link to other pages in HelpHub, Start from the next “/”. For example,
/support/article/administration-screens/
/support/article/glossary#absolute-path
#roles (to jump in the same page)
/support/wordpress-version/version-5-2/
If you find that you are unable to automatically link to articles; it’s because they are in draft mode and not published. You’ll have to do some manual copy and pasting.
If you need the help, Please ping @Kenshino or @atachibana in Slack in the #docs channel.
As of Apr/2019, almost all migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. were completed, and now we need show the warning text at the top of Codex page so that it can tell to visitor that this page was transferred to HelpHub. (e.g. Refer this page)
Before actual adding the message, we need final review of contents and re-synchronize with the latest Codex contents. Note: This task needs some experience on Codex and HelpHub.
1. Reserve the page for your process. 1) From this worksheet, search blank or Not Yet in “Transferred” column. 2) Enter “In Progress”.
2. Update Codex page so that include the warning message 1) From codex page, click Edit on right side menu. 2) Put following message below the language locator, and comment out the current Codex contents by “<–” and “–>”.
{{Languages|
{{en|WordPress Features}}
{{ja|WordPress Features}}
}}
This page was moved to https://wordpress.org/support/article/< HelpHub page> except above language locator.
<!--
... contents ...
-->
3) Click bottom Show preview and confirm your changes. 4) Enter the text “Transferred to HelpHub” in the Summary box and click Save page.
3. Release the page 1) Change “In Progress” to “Done” at above Step 1-2).
As of May/2019, almost all Version page (or release notes) were migrated to HelpHub, and now we need transfer old Codex page to HelpHub page. Already, licking of https://codex.wordpress.org/Version_5.0 is redirected to HelpHub page.
Follow below steps:
1. Reserve the page for your process. 1) From this worksheet, search blank or Not Yet in “Transferred�? column. 2) Enter “In Progress�? into the cell.
2. Insert transfer tab into Codex page 1) From codex page, click Edit on right side menu. 2) Put following tag at the top of the page, and replace n-n-n by matched version number. Refer this page.
3) Enter the text “Transferred to HelpHub�? in the Summary box and click Save page.
NOTE: Once you save the page, viewing the page will be redirected to HelpHub page. If you want to modify the saved page, add &action=edit to the URL. e.g. https://codex.wordpress.org/Version_5.0&action=edit
3. Mark the complete 1) Change “In Progress�? to “Done�? at above Step 1-2). .
Cut & Paste the contents from Codex page into the new article page.
Except development information such as function usages. HelpHub is general user guide. Those information should be moved to Theme/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.
As of Apr/2019, almost all migration were completed, and now we need show the warning text at the top of Codex page so that it can tell to visitor that this page was transferred to HelpHub. (e.g. Refer this page)
Before actual adding the message, we need final review of contents and re-synchronize with the latest Codex contents. Note: This task needs some experience on Codex and HelpHub.
1. Reserve the page for your process. 1) From this worksheet, search blank or Not Yet in “Transferred” column. 2) Enter “In Progress”.
2. Update HelpHub page by recent changes on Codex page. After the migration from Codex to HelpHub, someone might have modified the Codex page. Reflect those recent changes to HelpHub page. 1) From codex page, click History on right side menu. 2) Put the first marker on January 2017 3) Click Compare selected 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.
4) Confirm the recent changes and enhance them to HelpHub. 5) Read whole documents and fix the error if exists.
3. Update Codex page so that include the warning message 1) From codex page, click Edit on right side menu. 2) Put following message below the language locator, and comment out the current Codex contents by “<–” and “–>”.
This page was moved to https://wordpress.org/support/article/< HelpHub page> except above language locator.
3) Click bottom Show preview and confirm your changes. 4) Enter the text “Transferred to HelpHub” in the Summary box and click Save page.
4. Release the page 1) Change “In Progress” to “Done” at above Step 1-2).
