Auditing Lesson Plans

Lesson plans are now live on the Learn website. However, many are in varying states of completion. To determine where things are and more clearly communicate small chunks of contribution effort, we are auditing exactly what needs to be done yet.

Where to Start

For now, move past speaker lesson plans. We will coordinate @jillbinder on updating that content.

To determine if a Lesson Plan has been audited, view All Lessons. Audited plans will have the duration, instruction type, and experience levels filled in.

Select the next lesson plan that does not have these fields completed.

Commit to finishing auditing a single lesson before logging out. We can use the “Who’s editing” notification to tell if another user is editing the lesson at that time.

Top ↑

Formatting & Proofreading

Convert the lesson plan to Blocks.

Revise grammar. The Grammarly extensions can be helpful.

Top ↑

Revise internal links to stay within other lesson plans on Learn, not to 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/ or Training team handbook posts.

For Teacher Resources, find the appropriate Lesson Plan or Docs article (Support HelpHub or DevDocs).

Update any links to Codex by visiting the link, then following it to the new article location. Also update any links from WordPress.comWordPress.com An online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ to WordPress.org/support when possible.

Top ↑

Code Formatting

When converting posts to the 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. Editor mode, code snippets will default to a Code block. Modify this to the Syntax Highlighter block.

At this point, it may be beneficial to cross-check code with what appears on GitHub. A few cases of code not displaying in the editor but being live and inaccurate have occurred on published lesson plans. Copy/pasting from GitHub to Syntax Highlighter block usually works.

Then 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., select the language with Line Numbers enabled.

Top ↑

Editorial Metadata

We are using Edit Flow for auditing our content. You can drag/drop the right sidebar checklist to appear with the comment area.

Review the lesson plan content to assess if the plan has broken images, contains old callout notice formatting, code snippets, etc. Each of these can later be reviewed by one person interested in modifying just that area.

Feel free to use the Respond to this post button to leave comments for clarification.

Leave a message in the Training Team Slack Channel if you add additional Editorial Metadata within Learn.

Example Callout Notification:

Example Broken Image:

Top ↑

Lesson Plan Overview

To see the details of each lesson plan as a quick overview, manually complete the taxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. in the sidebar. Most lesson plans describe the time estimate or intended audience.

These will be viewable on the front of the site:

Top ↑

View the Published Lesson Plan

Update the article, then view the published version. Confirm if all displays as expected.

Top ↑

Trello

Find the lesson plan TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. card on the Training Team Trello Board. Update labels like “Needs Slides Displayed on Learn” and the link to the Lesson Plan on Learn as well.

Move it to the appropriate column – Live but needs some work, needs lots of work, etc.

View the GitHub repo to determine if the Lesson Plan has completed slides.

Navigate to lesson plan > slides > index.htmlHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. and read to see if actual content appears or if the template slide appears.

Top ↑

Submitting Issues

If you have a theme or functionality related issue, please submit it to https://github.com/WordPress/learn/issues/.

If you have ideas for Edit Flow functionality:
https://github.com/Automattic/Edit-Flow/issues

Last updated: