If you want to join the HelpHub editing tasks (Thank you!), there are some ways:
- Working ssues in the Documentation issue tracker
- Proof Reading
Working ssues in the Documentation issue tracker
The Documentation issue tracker is the central place for contributing to WordPress documentation. No actual documentation is hosted in this repository. Its purpose is to track all the issues for any part of WordPress documentation.
For more details about Documentation issue tracker, refer this page.
From Documentaion issue tracker, Look for issues of your interest. The Good first issues tag would be a good candidate. See this page for more information.
Or, you may wish to consider the documentation work required for each version such as WP 6.6 Documentation. For more information refer this page.
Once you have found an issue you want to work on, follow these steps:
- You browse issues and find what you like. Post in comment that you’d like to work on it and start working.
- Someone will assign you and move issue into “In progress” column.
- When your work is ready for review, post another comment mentioning @zzap , @atachibana or someone else if you were discussing it with someone else.
- Someone will move issue to “Review” column. After review you’ll be either asked to fix something or if you’d like to update documentation yourself.
- When documentation is updated the issue is moved to “Done” column.
Proof Reading
Read HelpHub page and give us feedback. Any comments are welcome!
- Read any pages under the https://wordpress.org/documentation.
- If you find refinement points, technical errors, editing error etc., report an issue.
Any comments are welcome. For example:
- Unclear or wrong description
- Missing steps, URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org links
- Ancient screenshots
- Ancient description (ex. WordPress 2.x, MySQLMySQL MySQL 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.)
- Using of out of date Plugins or Themes
Editing Hints
If you find more inconsistencies or discovered something else we should inform the other migrators; do let us know!
- Default editor is BlockBlock Block 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 (GutenbergGutenberg The 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/). 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 Site A 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 pingPing The 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 Slack in the #docs channel.
Reference
Archives
Below projects were completed. Thanks.
Getting Account
To write/modify the pages under the https://wordpress.org/support, you have to get permission of write access. Send your WordPress.orgWordPress.org The 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 SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. via direct message.
Gutenberg document modification
WordPress Version 5.0 introduced the Block 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.
- Open the “Gutenberg Docs” tab of Spreadsheet: https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=2125284625
- Reserve a target page. Type your name in ‘Writer/Editor’ and change Status to ‘In Process’.
- Click the link in ‘Block Editor Page’ column.
- Follow the instruction in ‘Tasks’ column. Or please write new article as you like
- Save as Draft (Do not Publish, yet)
- Change the Status of Spreadsheet to ‘Done’.
Transferring Codex page to HelpHub [good first contribution]
As of Apr/2019, almost all migrationMigration Moving 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).
4. (Bonus) Enhance the comments from WCEU 2018 contributor dayContributor Day Contributor 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/. (Column T)
Transferring Version page [good first contribution]
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.
{{#dotorgredirect: https://wordpress.org/support/wordpress-version/version-n-n-n/}}
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).
.
Version pages migration
Please migrate Version pages or Release Notes such as “Version X.Y.Z” page in Codex to HelpHub site.
- Open the “Release Notes” tab of Spreadsheet: https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=1995801274
- Put your name in ‘Migrator’ column and change the Status to ‘In Process’.
- Login to https://wordpress.org/support (if you can’t, refer below ‘Getting Account’)
- From Toolbar, select New > WordPress Version. Or, From Dashboard, select WordPress Versions > Add New.
- Cut & Paste the contents from Codex page into the new page.
- Fix the links to Codex page to WordPress.org/support. Refer other migrated page such as https://wordpress.org/support/wordpress-version/version-4-9-9/.
- Save as Draft (Do not Publish, yet)
- Change the Status of Spreadsheet to ‘Done’.
Codex contents Migration
Please migrate Codex pages of user documents to wordpress.org/support
- Open the “Phase-2 Contents” tab of Spreadsheet: https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=554277336
- Reserve a target page. Type your name in ‘Migrator’ and change Status to ‘In Process’.
- Go to https://wordpress.org/support and click New > Article from Toolbar.
- 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/PluginPlugin A 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.
- Modify the contents.
- Replace link of Codex page by HelpHub Page.
Ref. Phase-1 Contents and Phase-2 Contents for its pair - Download images via the Codex page, and add to Media Library of HelpHub site and replace the old contents.
- See also below “Editing Hints”
- Replace link of Codex page by HelpHub Page.
- Preview it and compare with Codex Page.
- Save as Draft (Do not Publish, yet)
- Change the Status of Spreadsheet to ‘Done’.
Transferring Codex page to HelpHub
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 revisionsRevisions The 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).
