Validating and Triaging Content Error Reports

When users have feedback about the content on Learn, they submit Content Error Reports to the team. This feedback is recorded 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 anyone to come along and process. You can find these issues by using the Content Error label in the team’s GitHub repo.

Once an issue has been submitted, it goes through two stages – validating and triaging. Follow the steps below to validate and triage Content Error Report GitHub issues.

Validating Content Error Reports

No special access is needed to validate reports. Anyone in the Training Team can do this.

When you validate a report, you check to see if the report is relevant. Sometimes a fix may have already been applied to the content, or the report was just spam. In these cases, the report is no longer relevant, and can be closed.

Follow these steps to validate Content Error Reports:

  1. FilterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. GitHub issues that are open and have both the Content Error and Awaiting Triage labels. (Or, simply click this link.)
  2. Find a report that still has 4 tasks listed underneath it.
    • If the report says at least 1 task has been completed, then it means the issue has already been validated and is waiting Triage.
Pointing out where GitHub Content Error Report show if any tasks have been completed.
The top issue still has 4 tasks remaining, and can be validated. The bottom one already has a task completed, and does not need to be validated.
  1. Open the issue and read the issue description. Then, open the piece of content in question and see if the report is a valid report.
    • If the report IS valid, then tick Error Validated in the issue description, and move to step 4.
    • If the report IS NOT valid, then leave a comment on the GitHub issue as to why the issue is not valid. After you’ve submitted your comment, tick Error Validated in the issue description. You can then skip the remaining steps.
    • Notice: You’ll tick Error Validated regardless of whether the issue is valid or not.
  2. Figure out what needs to change for the issue to be fixed. Write your proposed fix as a comment on the issue. Then, tick Error fix proposed.
    • If a screenshot needs to be updated and you are able to create the correct screenshot, you can upload that image into your comment, too.

And that’s it!

Top ↑

Triaging Content Error Reports

Triaging issues can only be completed by members of the Learn Content Triage team. All Faculty members should be a member of this team. If you are not a Faculty member but are interested in triaging Content Error Reports, please let a Faculty member know! 😀

The goal of triaging Content Error Reports is to complete the necessary content 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. and close out the GitHub issues. Here’s how:

  1. Filter GitHub issues that are open and have both the Content Error label. (Or, simply click this link.)
  2. Choose an issue that already has at least 1 task completed. This generally means the report has already been validated and is waiting for a member of the Triage Team to take next actions.
Pointing out how to view completed tasks and identify Content Error Reports needing triaging.
The top issue has some tasks completed and can be triaged. The bottom issue still has 4 tasks remaining and needs validating first. Skip these.
  1. Review the issue and assign appropriate labels in the right sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme..
    • Remove Awaiting Triage
    • Assign an appropriate [Content Type] label
    • If regarding localized content, assign an appropriate [polyglots] label
    • If the change is a suggestion, more than an error, remove [Type] Bug and assign Suggestion
    • If the issue relates to accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility), assign Accessibility
  2. Assign the issue to the correct project in the right sidebar.
    • The majority of issues will be related to Learn content and should be assigned to LearnWP Content Development project.
    • Sometimes, issues will be related to the Learn siteLearn site The Training Team publishes its completed lesson plans at https://learn.wordpress.org/ which is often referred to as the "Learn" site. itself. In this case, assign the issue to the Website Development project. Also, remove the Content Error label.
  3. Review the proposed fix. Once reviewed, tick Error fix reviewed in the issue description.
  4. If you ARE ABLE to apply the fix, then follow these steps to correct and close out the issue:
    • Make the necessary changes to the content.
    • Tick Error fix published in the issue description.
    • Assign yourself to the issue in the right sidebar.
    • Add a note briefly describing the changes you made and press Close with comment.
  5. If you ARE NOT ABLE to apply the fix, then contact the original content creator to see if they can.
    • If the original content creator can make the change, then great! Assign the issue to them and leave it in their hands.
    • If the original content creator does not respond, or is not able to make the change, that’s ok. Raise the issue in the #training 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/. channel with other @faculty-editors to consider next steps.

Thanks for triaging Content Error Reports!

Last updated: