Dev-squad GitHubGitHubGitHub 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/ triage: Thursdays 07:00 UTC
The first step to getting new quality content on Learn WordPress is to vet the various content topic ideas shared by the WordPress community. These ideas can stem from personal interest to crowdsourced consensus, but no matter how it comes to the Training Team, it will require vetting before it is greenlit for content creation and publication on the Learn WordPress website.
Subject Matter Experts (SMEs) are community members who utilize their expertise to vet submitted content topic ideas. In general, SMEs look to assess these ideas for relevance and priority. SMEs may also be contacted by Content Creators as the content is being developed, requesting additional information and/or assistance to create accurate and informative content.
Outlined below are the guiding processes for vetting content topic ideas for Learn WordPress. You can also watch this Online Workshop that will guide you through the process:
All new Topic Ideas are created as a GitHubGitHubGitHub 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/ issue on the Learn GitHub repository using the Topic Ideas GitHub issue Template. Once submitted, issues are automatically added to the LearnWP Topic Vetting project board. Issues are first triaged for spam/duplicates etc. by Administrators (Admins) before landing in the “Awaiting Vetting” column for SMEs.
Topic submitters are asked to fill out as much of the information in the GitHub issue as possible. However, as ideas are submitted from a wide audience, details may vary depending on the issue. SMEs are tasked with:
Assessing if the topic is something the team should prioritize and add to Learn.WordPress.orgWordPress.orgThe 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/.
And if so, then making sure adequate details are filled out in preparation for the Content Creator who will create the content.
Once submitted, Admins will first triage issues by closing out spam and duplicate ideas. When closing an issue, leave a brief comment as to why.
Duplicate ideas should be searched for in the team’s GitHub repo. Make sure to include both open and closed issues when searching from https://github.com/WordPress/Learn/issues.
The Tutorials section, Lesson Plans section, and Courses section in Learn’s dashboard can also be searched for content that may have been published before the team started tracking content development on GitHub.
Admins will also:
Remove the Awaiting Triage label.
Assign at least one [Topic] label.
Assign at least one [Content Type] label.
If the issue lacks some of the required information, leave a comment asking the submitter for more information.
If no response is provided within two weeks, close the issue with a comment.
If all content has been provided, change the issue status to Awaiting Vetting.
It can sometimes be difficult to assess topic ideas on an individual level, so don’t hesitate to reach out to Faculty SMEs for a second opinion along the way. You can do so by pinging the @faculty-sme group in the #training Slack channel.
Hi @faculty-sme 👋🏼 I need a second opinion as I vet this topic idea: link_to_GitHub_issue What do you think about XYZ? Thanks!
Open an issue, then copy-paste the following text into a comment. This will act as your guide as you vet the topic:
# Vetting Checklist for SMEs
- Priority - either High, Medium or Low:
- Feedback regarding the topic description:
- Feedback regarding the learning objectives:
- Any other feedback:
# Related Resources
<!--
If you know of other related resources that would assist in creating this content, list them below.
-->
Take note of what content type this is a suggestion for. This should be listed in the issue body, in the issue title, and added as a label.
Someone might be suggesting a new content type for an existing piece of content. And that is OK! Assess whether the content type would make sense for the topic being suggested.
Assess the relevance of the issue and assign a priority.
If an idea is not relevant, add a brief comment describing your reasoning and press Close issue.
If an idea is relevant, write either High, Medium, or Low in your comment.
Priority is assessed by whether or not the topic is critical to something in the latest release, hits on a needs analysis trend, or fixes a gap in previously published foundational content.
If a topic already exists, but as a different content type, then the topic could be approved as a lower-priority item so that topics with no content at all can be prioritized.
Assess the submitted details of the topic, and provide feedback.
Add links to any other related resources you think will assist the content creator when creating this content.
Once you’ve submitted your comment, pingPingThe 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.” Faculty Admin in the #training Slack channel, asking them to process the issue for you and move it to the Content Development project board.
You can ping all Faculty Admin at once by mentioning the @faculty-adminSlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. group.
Hi @faculty-admin 👋🏼 I have vetted the topic on this GitHub issue: link_to_GitHub_issue Could you process this issue and move it to the Content Development project board please? Thanks!
Once vetted, relevant labels are added, and the issue is then moved to the LearnWP Content - Development project board.
The Learn Content Triage membership on GitHub is required to add labels and move issues between project boards. All Faculty members are given this access, and contributors who have shown consistent contribution may also request access. Please contact a Training Team Representative or Faculty Member in the #training Slack channel if you lack the appropriate access to perform this work.
Ensure all details have been filled in, either in the issue itself by the topic submitter, or in the comments by the SME.
Add at least one each of the the following labels:
[Priority] – High, Medium, or Low
[Audience] – Contributors, Designers, Developers, Speakers, or Users
[Experience Level] – Any, Beginner, Intermediate, or Advanced
Version – 6.0, 6.1, 6.2, etc. (if applicable)
Remove the Needs Subject Matter Expert label.
Move the issue from LearnWP Topic Vetting (Status: Vetted Topics) to LearnWP Content - Development (Status: Ready to create).
You can do this by clicking the cogwheel next to Projects in the right sidebarSidebarA 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, deselecting the current project board, and selecting the new project board.
Copy-paste one of the following as a comment to the issue, listing next-steps.
Tutorial
This topic is ready to be created. Please follow the handbook page Creating a Tutorial for next steps.
Course
This topic is ready to be created. Please follow the handbook page Courses for next steps.
Online Workshop
This topic is ready to be created. Please follow the handbook page Online Workshops for next steps.
Lesson Plan
This topic is ready to be created. Please follow the handbook page Lesson Plans for next steps.
(B) If the topic submitted requires multiple content types to be created, then a GitHub issue should be created for each content type and a link back to the related content issues should be provided in the body of the issue to allow for cross-collaboration or reference.
