Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UPDATE: Create and Publish Custom GitHub Actions #45

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

a-a-ron
Copy link
Collaborator

@a-a-ron a-a-ron commented Sep 28, 2022

The purpose of this PR is to see how we can increase the completion rate and improve the user experience. Below is the August data for this module:

Module stats

Module Completion Rate # completed / # started
Create and publish custom GitHub Actions 15.25% 12/116

For reference: See the parent issue for context

Module file structure

Screen Shot 2022-09-28 at 11 45 09 AM

Items to review for this module

We need to conduct a performance review on each of these modules to see how we can increase the completion rates, improve the user experience, and maintain the level of quality that we set for our learners.

Items for consideration

  • Thoroughly review the module content for flow, narrative, and length
    • Review use of images, tables, and other visual elements
    • Does the content read like a doc or like a conversation guide?
    • Does the estimated time to complete each unit remain accurate?
  • Review the introduction unit
    • Does it capture your attention?
    • Does it contain repetitive content from the course title page?
    • Do the learning objectives/scope align with the content?
    • Does the target audience match the content?
    • Do we accurately describe the module and learning objectives? (Is it possible that learners start the course thinking it's one thing to find out it's another?)
  • Review the module exercise
    • Does it work?
    • Does it enforce a learning objective?
    • How is it placed in the module? Should we move it around?
    • Do we need other exercises?
  • Review the questions at the end of the module
    • Do the questions test on content taught in the module?
    • Do the questions follow best practices for item writing?

Estimated Work Effort

Task Hours
Detailed module review 18 hours
Action items as identified from review TBD

Action items for this module

After a detailed review of the module, below are the items we need to add/remove/modify to improve the learner experience for this module.

🚧 {Plan of action in comment below}🚧

@rmallorybpc rmallorybpc self-assigned this Sep 28, 2022
@rmallorybpc
Copy link
Collaborator

rmallorybpc commented Sep 28, 2022

Plan of action

Launch page

  • The introduction paragraph is very detailed and it has long sentences with a lot of learning objectives. The introduction paragraph and learning objectives completely overlap. Decrease the opening paragraph content.
  • The learning objectives can be reworked to better align with the topics in the units and engage the user more.
  • Add information from the Introduction unit to add more content and remove from the Introduction unit.

Introduction

  • The introduction is too long and does not create a story for the learner.
  • The introduction does not lead into the learning objectives, and then connect to the unit titles.
    - [ ] Is there a chance that a learning who knows workflows and CI would know this information?
  • Introduce the unit here, removing duplicate objectives and prerequisites.

Content Units

  • Better story-like opening sentence.
    - [ ] Change the order in unit 2
  • The images are good.
  • Unit 3 Publish a custom GitHub action looks good.
  • The length matches other modules.

Exercise

  • The exercise on the launch page says that the exercise takes 6 min. The exercise states, "How long: This course is 6 steps long and takes about 1 to 2 hours to be completed." This could be a big stopping point.
    - [ ] The exercise is writing a GitHub JavaScript Action and automation. The learning should point out the Javascript a bit more.
  • Add the exercise length to the exercise summary, instead of the summary page length (ex. 6min)

Knowledge Check

  • Q1 - Ruby is not mentioned in the units.
  • Q2 - is fine.
  • Q3 - Options 1+4 are super close. I would write 4 as, echo "::errorThis is an error message::". That would be a bit more clear as incorrect.

Overall

  • The writing overall is ok, with the notes above.

@rmallorybpc
Copy link
Collaborator

rmallorybpc commented Sep 29, 2022

Move Introduction information

This comment was used to save the moved content, copy and paste, and compare the content across the two files.

Learning objectives

In this module, you will:

  • Identify the metadata and syntax needed to create custom GitHub actions
  • Learn best practices to publish a private or public GitHub action
  • Consume actions within a workflow file
  • Create custom JavaScript based actions
  • Publish a newly created action to the GitHub Marketplace

Prerequisites

This module assumes you have basic familiarity with GitHub Actions and workflows.

Remove duplicate information from the Introduction unit.
Move Learning Objectives and Prerequisite from the Introduction to the Launch page (index.yml file).
Update the Introduction to start the learning story.
Quick rework edit.
Minor editing.
Reworked the learning objectives.
Edit to the order of the opening paragraph.
Edits for learner flow.
Updated the length information.
Updated question one, anwers, and explanations because Ruby was not discussed in the unit contents. Updated answer 4 in question 3 because it was too close to answer 1.
Added the prerequisites and learning objectives back
@rmallorybpc rmallorybpc added review For review by Aaron and removed in progress labels Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance maintenance module-update review For review by Aaron
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants