Validating and Applying Content Feedback

When users have feedback about the content on Learn, they submit Content Feedback 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 in the LearnWP Content – Feedback project board.

Once an issue has been submitted, it goes through two stages – validating and triaging. Follow the steps below to validate and triage Content Feedback GitHub issues. The following Online Workshop recording will also guide you through the feedback validation process.

There have been updates to this process since this video was recorded. Please refer to the text version for the latest steps.

Validating Content Feedback issues

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 Feedback:

  1. Open the list of content feedback awaiting validation.
  2. Open any issue, and in a new comment, copy-paste the following check-list:
# Feedback Validation Checklist:
- If this is reporting an issue, can you confirm/reproduce the issue? (Yes or No): 
- What should happen next to apply the feedback?: 
  1. If the feedback is reporting an issue in the content, confirm if you can still see/reproduce the issue.
    • If you can, type YES next to the first item in the list you just copied across, and move to step 4.
    • If you can’t, type NO.
      • If it looks like the issue has been fixed already, leave a comment with your findings and move to step 5.
    • If the feedback is unclear, leave a comment explaining what you tried and ask the author for more information. You can do this by @-mentioning the author in your comment.
      • You can skip steps 4 and 5 below.
  2. Leave a note about what needs to happen next, and press Comment.
    • For example, 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.
  3. If the feedback has been validated, and the next steps are clear, mention the @WordPress/learn-editors team on the GitHub issue, letting them know. They will be able to move the issue to the Awaiting Fix status, apply the necessary changes to the content, or close the issue for you.

Thanks for validating Content Feedback GitHub issues!

Top ↑

Changing the status on validated Content Feedback issues

The Learn Content Triage membership on GitHub is required to change the status of issues. Experienced team members are given this access, and contributors who have shown consistent contribution may also request access. Please contact a Training Team Representative or 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.” @tt-admins in the #training Slack channel if you lack the appropriate access to perform this work.

  1. 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. of the issue, change the status from Awaiting Validation to Awaiting Fix.
  2. Remove the Awaiting Triage label.

Top ↑

Applying Content Feedback

Fixing issues (or applying changes) in content can only be completed by those with access to edit content on https://learn.wordpress.org/. Please ping @tt-admins in Slack to apply the changes for you if you do not have access.

Once content feedback has been validated, the change will need to be applied to the content. Please follow these steps to apply the changes and close out the GitHub issue.

  1. Open the list of content feedback that have been validated and are awaiting for a fix.
  2. Open any issue and apply the suggested changes.
    • If an issue was assigned to someone but no movement has been made in the last two weeks, feel free to work on the issue yourself.
  3. Leave a brief comment about the changes you made and press Close with comment.

Last updated: