Learn icon indicating copy to clipboard operation
Learn copied to clipboard

What is WP-CLI and Why Manage WordPress in the Terminal - Lesson Plan

Open courtneyr-dev opened this issue 3 years ago • 3 comments

Topic Description

High level overview of WP-CLI covering why and when to use WP-CLI.

Related Resources

Links to related content on Learn, HelpHub, DevHub, GitHub Gutenberg Issues, DevNotes, etc.

  • Official website: https://wp-cli.org/
  • Handbook: https://make.wordpress.org/cli/handbook/
  • GitHub: https://github.com/wp-cli/wp-cli

Guidelines

Review the team guidelines

Development Checklist:

  • [x] Gather links to Support and Developer Docs
  • [x] Consider any MarComms (marketing communications) resources and link to those
  • [x] Review any related material on Learn
  • [ ] Define several SEO keywords to use in the article and where they should be prominently used
  • [ ] Description and Objectives finalized
  • [ ] Create an outline of the example lesson walk-through
  • [ ] Draft lesson plan
  • [ ] Copy edit
  • [ ] Style guide review
  • [ ] Instructional Review
  • [ ] Final review
  • [ ] Publish
  • [ ] Announce to the Training team
  • [ ] Announce to lesson plan creator
  • [ ] Announce to marketing
  • [ ] Gather feedback from lesson plan users about the quality

Description

A short paragraph explaining what is covered in the lesson plan. This should be text that can be copied and used in a meetup or workshop description.

Objectives

After completing this lesson, participants will be able to:

  • Developers will be able to explain what WP-CLI can do
  • Developers will be able to summarize why to use WP-CLI
  • Developers will be able to discuss common uses of WP-CLI

It’s required that you include a bulleted list of objective(s) for each lesson plan. Objectives should be worded as actions that the participant can do once they’ve finished. See Bloom's Taxonomy of Action Verbs (PDF) as a reference. Avoid using words like "know," "understand," "be introduced to," etc. There should be one assement item for each objective (see below).

Target Audience

Who is this lesson intended for? What interests/skills would they bring? Put an "x" in the brackets for all that apply.

  • [ ] Users / Content Writers
  • [ ] Designers
  • [x] Developers
  • [ ] Speakers
  • [ ] Organizers
  • [ ] Kids

Experience Level

How much experience would a participant need to get the most from this lesson? Put an "x" in the brackets for all that apply.

  • [x] Beginner
  • [ ] Intermediate
  • [ ] Advanced

Type of Instruction

Which strategies will be used for this lesson plan? Put an "x" in the brackets for all that apply.

  • [ ] Demonstration
  • [ ] Discussion
  • [ ] Exercises
  • [ ] Feedback
  • [x] Lecture (Presentation)
  • [ ] Slides
  • [ ] Show & Tell
  • [ ] Tutorial

Time Estimate (Duration)

How long will it take to present this lesson? Put an "x" in the brackets for the one that applies.

  • [x] 1 hour or less
  • [ ] 2-4 hours (half-day)
  • [ ] 5-8 hours (full-day)
  • [ ] 2 days
  • [ ] 3 days or more

Prerequisite Skills

Participants will get the most from this lesson if they have familiarity with:

  • Installing WordPress
  • Needing to

For example:

  • Experience with HTML and CSS
  • Completed the Basic WordPress Concepts lesson

Readiness Questions

  • Does clicking the mouse seem tedious?
  • Do you need to quickly update, deploy tests, or manage multiple sites and steps more efficiently?

A list of questions for participants to see if they have the background and skills necessary to learn and understand the lesson.

For example:

  • Do you want to makes changes to your theme yourself?
  • Do you know how to write CSS?

Materials Needed

  • Item 1
  • Item 2

A list of files, resources, equipment, or other materials the presenter will need for the lesson.

For example:

  • A local install of WordPress
  • The files for the TwentySixteen theme

Notes for the Presenter

  • Note 1
  • Note 2

A list of any handy tips or other information for the presenter.

For example:

  • Participants may need to download the TwentySixteen theme before beginning
  • What to do if there’s no projector or internet available
  • What to do if a participant doesn’t have the necessary set up
  • How to handle different opinions about the topic

Lesson Outline

  • First do this
  • Then move on to this
  • Finish with this

The plan for the lesson. Outline form works well.

For example:

  • Talk about what a theme is
  • Demonstrate how to install and activate a theme
  • Practice exercises to have participants find and install a theme on their own site

Exercises

Exercise name

Short description of what the exercise does and what skills or knowledge it reinforces.

  • Short point or step of the exercise
  • And another one

These are short or specific activities that help participants practice certain components of the lesson. They should not be fully scripted exercises, but rather something that participants could do on their own. For example, you can create an exercise based on one step of the Example Lesson.

Assessment

There should be one assement item (or more) for each objective listed above. Each assessment item should support an objective; there should be none that don't.

Write out the question.

  1. Option
  2. Option
  3. Option
  4. Option

Answer: 3. Correct answer

A few questions to ask participants to evaluate their retention of the material presented. They should be a measure of whether the objectives were reached. Consider having a question for each objective.

Additional Resources

  • Resource 1
  • Resource 2

An optional section that can contain a list of resources that the presenter can use to get more information on the topic.

For example:

  • Link to information on the Codex
  • Theme Review Team's Handbook

Example Lesson

An example of how the lesson plan can be implemented. Written in script form as one possible way an presenter might use this lesson plan at an event, with screenshots and instructions if necessary.

Section Heading for Example Lesson

You will likely need to break the Example Lesson down into multiple sections.

Lesson Wrap Up

Follow with the Exercises and Assessment outlined above.

courtneyr-dev avatar Apr 26 '22 13:04 courtneyr-dev

👋

rosswintle avatar Apr 26 '22 14:04 rosswintle

Catching up after a short while.

I'm not sure I want to be making a lesson plan here. Ideally I'd make what I think is called a "Workshop" - a video tutorial - that can be put on learn.WordPress.org. I think that's where the value is here.

If we want to subsequently turn it into an in-person, meetup-style presentation then we can, but that's not really my strength.

I'm not entirely certain why this lesson plan here (that I'm commenting on) is my next step (see #632)

rosswintle avatar Jun 08 '22 10:06 rosswintle

Ross Wintle is not working on it, instead working on a workshop. We can move this to ready to create column again. So anyone else can pick this.

webtechpooja avatar Sep 13 '22 08:09 webtechpooja