Editing Articles

Topics

As of Feb/2018, the initial contents were prepared in the HelpHub staging site. Below wiki page lists planned all contents and links to the already migrated pages:
https://github.com/Kenshino/HelpHub/wiki/All-Contents

If you want to join the HelpHub editing tasks (Thank you!), there are some ways:

Proof Reading Proof Reading

1. Read any HelpHub page depending on your interests and skills.
2. If you find refinement points, errors even typo in it, please ping @Kenshino or @atachibana in Slack in the #docs channel. For example,

  • Unclear or wrong description
  • Missing steps, URL links or screenshots
  • Ancient description (ex. WordPress 2.x, MySQL 4.1, etc.)
  • Using of out of date Plugins or Themes

Note: Ignore page design failures such as

  • No space between paragraphs
  • Wrong bullet position
  • Invalid layout etc.
  • Link to original Codex pages. They will be replaced by batch operation before its release.

HelpHub staging site is under construction. If you want to grab the development status, refer development repository or join HelpHub development.

Top ↑

Content Migration or Editing Content Migration or Editing

Some pages need to be migrated from current Codex article, or modified. If you would like to assist with migrating or editing articles, these are the steps you need to follow:

  1. Pick an article that you would like to migrate or edit. Search “Not Assigned” in Column ‘G’ (Migrator) or ‘H’ (Editor) in the
    https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=835534324
  2. Replace “Not Assigned” by your Slack username to reserve it and update the status in Column ‘I’ (Comment).
  3. Request access to http://wphelphub.com/ by sending 1) your WordPress.org account 2) e-mail address to @atachibana on Slack via direct message.
  4. Create a new post on HelpHub and copy the content from the Codex article into it, or edit existing article.
    • You can manually copy the content or you can choose to the Codex Migration Tool that @atachibana created. An explanation of the tool is provided on this blog post.
  5. Edit the content, paying particular attention to the following:
    • Default editor is Gutenberg. Unfortunately almost all articles are one big block. You may use Classic Editor, or Work with some difficulties…
    • Simple is best – delete narrative sentences or change them to bullet or numbered list.
    • Use simple language – understanding is key!
    • Use semantic headings: No <H1> in the article content – start sections with H2s and work down from there where appropriate.
  6. Add screenshots where appropriate – if the article is describing any user interface element then it must include a screenshot.
  7. Ping to #docs channel after completing editing it.

If you need the help, Please ping @Kenshino or @atachibana in Slack in the #docs channel.