How to help with the overhaul of documentation issue tracker in GitHub

While writing and updating HelpHub articles for 6.9, the team discovered that many articles have not been updated making it difficult to maintain the quality of the documentation. For this reason, the team is incurring in an overhaul of the documentation with 3 main goals:

  1. Improve the quality of the documentation.
  2. Use the changelog to recognise contributors.
  3. Update the blocks articles before WP 7.0 is released.

What is the overhaul and how it works

A project has been created in GitHubGitHub GitHub 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/ for each of the categories plus the blocks – see links below. In each categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. there is a READ FIRST issue with instructions.

Basically, a new issue is open per 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./feature with the title “Overhaul XX block documentation”.  Look at the related open issues, see what’s still useful, and close anything that’s ancient/irrelevant. For other details, follow the instructions in the READ FIRST article.

Key things to remember:

  1. Self-assign the issue you decide to tackle.
  2. Close those outdated issues! Don’t let them hang around.
  3. Write your final updates in the comments first, before you update the actual article in WordPress.
  4. Need to edit the docs site? 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.” @estelaris or @milana_cap for access.
  5. Don’t forget the contributors! Add anyone who suggested something (even if you don’t use it) to the changelog. You only need to contribute once to become a Docs contributor!
  6. If you can’t figure out a contributor’s WordPress username, just ask in the 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/. docs channel.
  7. Note: if there is only one issue open  for a feature/block, only the title has been edited to add the word “Overhaul”. This is done to avoid extra issues and extra work.

The list of the overhaul projects in GitHub:

Note: the audit on the GH docs issue tracker is still happening, thus projects below will be updated as soon as possible.

Props to @milana_cap and @mosescursor for reviewing this post.