Skip to content

Conversation

a-a-ron
Copy link
Collaborator

@a-a-ron a-a-ron commented Jan 10, 2023

…-phases-of-a-GitHub-Actions-Importer-migration.md

Added in content for first learning unit.
…tions-Importer-CLI-Extension-and-ensuring-its-up-to-date.md

Added content to 2nd learning unit, How to install GitHub Actions Importer CLI Extension, need to edit for grammar and format
Condensed learning units to 3.
Removed bold format
…-and-what-is-not-automatically-migrated.md

Added in content
Condensed learning objectives to just these 2: 
- Review how to install the GitHub Actions Importer CLI Extension and ensure it's up-to-date and learn about supported CI platforms
- Comprehend how to execute the audit, forecast, dry-run, and migrate commands and what is not automatically migrated
…uring-its-up-to-date.md

Added an intro sentence to start off the unit
…uring-its-up-to-date.md

Added transition sentence to next unit.
…ted.md

Added unit 1 as an intro to scale down the units. Unit 1 also felt redundant since we combined all the of the commands into a single unit.
…ted.md

Updated wording from unit to section and added content from unit 1 as an introduction
…-migration.md

Deleting to reduce redundancy with last unit and to combine the two.
…uring-its-up-to-date.md to 2-How-to-install-GitHub-Actions-Importer-CLI-Extension-and-ensuring-its-up-to-date.md
…ctions-Importer-CLI-Extension-and-ensuring-its-up-to-date.yml

Updated name and duration in minutes
…ted.md to 3-How-execute-GAI-commands-and-what-is-not-automatically-migrated.md
…s-and-what-is-not-automatically-migrated.yml

Edited name and updated duration in minutes
Bulk uploaded images
Edited grammar in the learning objectives
…uring-its-up-to-date.md to 2-How-to-install-GitHub-Actions-Importer-CLI-extension-and-ensure-its-up-to-date.md

Updated title of unit
Added content to the exercise unit
@camihmerhar
Copy link
Collaborator

camihmerhar commented Jan 17, 2023

Howdy @ethanis!

Here is the outline for the GAI module! Would love to get your thoughts on what we have so far.

Here are a couple of questions we wanted your thoughts on as well:

  • The outline currently has two content units. Does the flow of content seem right or should we create a 3rd content unit to categorize the content better?
  • What are your thoughts on the learning objectives?
  • What would you change or add to the outline?

Let @a-a-ron and me know if you have any questions!


Introduction

Learning Objectives

  • Review how to install the GitHub Actions Importer CLI Extension, ensure it's up-to-date, and learn about supported CI platforms
  • Comprehend how to execute the audit, forecast, dry-run, and migrate commands and learn what is not automatically migrated

Prerequisites

  • You must have been granted access to the public preview for the GitHub Actions Importer
  • You must have credentials to authenticate to the GitHub Packages Container registry. For more information, see "Working with the Container registry"
  • An environment where you can run Linux-based containers, and can install the necessary tools
    • Docker is installed and running
    • GitHub CLI is installed

Unit 1 - How to install GitHub Actions Importer CLI Extension and ensure its up-to-date

  • How to install GitHub Actions Importer CLI extension
  • Updating the GitHub Actions Importer CLI
  • Authenticating at the command line
  • GitHub Actions Importer CI supported platforms

Unit 2 - How to execute GitHub Actions Importer commands and what is not automatically migrated

  • How to audit your pipelines
  • How to run the forecast command
  • How to run a dry-run migration
  • How to execute your migration
  • What is not automatically migrated

Exercise

  • GitHub Actions migrations powered by Valet
    • Allowing learner to choose their learning plath based on their CI pipelines

Knowledge Check

Questions focused on the content we went over in the module

Summary

Quick review of what we learned in the module

More information on GAI:

Added questions, answers, and explanations.
Removed creative instructions portion
@JenniferKerns
Copy link
Contributor

Hello @camihmerhar!
I have a few pieces of preliminary feedback to share:

  • The link to the content for unit 2 actually links to unit 1
  • Our Field Engineering style guide (WiP!) includes some style decisions specific to GitHub Actions Importer. I'm happy to respond to any queries you might have about naming, language, etc.
  • The correct source for our labs repo is: https://github.com/actions/importer-labs
  • We need to keep a watchful eye out for any residual references to the code name Valet
  • I would probably rename the units. (something like: Unit 1 - How to install, update, and configure GitHub Actions Importer; Unit 2 - How to run GitHub Actions Importer commands/Unit 2 - How to use GitHub Actions Importer)

question: Do you want me to read through the draft content?

camihmerhar and others added 7 commits February 22, 2023 18:55
Updated links from valet to actions and rearranged the opening paragraph for flow.
…r.md

Removed the hyphens in up to date and improved the transition statement going into the next unit.
Bulleted out the actions that the audit command does
Added a transition statement after the audit section
deleted - # Edit as appropriate for your portfolio area
@camihmerhar camihmerhar added the review For review by Aaron label Feb 24, 2023
@a-a-ron
Copy link
Collaborator Author

a-a-ron commented Feb 27, 2023

Hey @camihmerhar. After our 1:1 today and taking some time to review the module, I have some thoughts that I'll address by each file.

2-How-to-install,-update,-and-configure-GitHub-Actions-Importer.md

(We need to remove the commas in the file name)

As we discussed, I agree that the current install/update information is redundant since we cover it at the beginning of each available lab. I propose that we remove this information and repurpose this unit to better explain and introduce GAI. For example, in the introduction unit, we say that GAI is designed to help you forecast, plan, and facilitate migrations to GitHub Actions but we then move right into steps to install it and then move right into the 4 commands (audit, forecast, dry-run, and migrate). I feel like we are missing the connection between the initial introduction with the learning objectives and the 4 commands that will be used.

What are your thoughts on removing the install/update content and add some content to introduce each section that GAI is designed to help you with (forecast, plan, and facilitate). We can use this unit to provide a high-level overview of why these phases are important or needed and the transition to the 4 commands that are relevant to these areas. I think it will flow better. I don't want to copy/paste content from the blog post but If we could summarize that content into this unit before introducing the 4 commands then I think that would help fill this gap.

3-How-run-GitHub-Actions-Importer-commands.md

This unit looks pretty good. I would remove the entire links section at the top (lines 14-19). We introduce these commands at the top so I think this is redundant and I don't want the learner to jump around. I like that we continue to talk about the lab at the beginning of the unit, but I don't want to link to the lab right now. That will prompt the learner to leave the module before we discuss the content in the unit.

5-exercise.md

Can we reformat this unit to match our other exercise units? We can just link out to the lab instead of providing the learning lab section that is included in the importer-labs repo. Here's an example of an exercise file. We just need to edit the content to introduce these specific labs and then change the link.

camihmerhar and others added 18 commits March 1, 2023 19:51
…r.md

Removing this unit since we agreed it was redundant to the labs exercise
Added a beginning section that covers the planning and migrating phase and divided the unit by those two phases and added the link to the labs at the bottom
Updated learning objectives
Updated the unit number and the learning objectives
Updated to meet the established exercise file
…Learn-about-the-two-distinct-phases-of-a-GitHub-Actions-Importer-migration-and-their-associated-commands.md

Updated title
…rter-migration-and-their-associated-commands.md

Removed docs links -- felt like they distracted the learner
…rter-migration-and-their-associated-commands.md
…rter-migration-and-their-associated-commands.md

Updated the transition into the lab exercise
…uring-its-up-to-date.yml

deleted the file since we deleted the first unit
…ted.yml to 2-Learn-about-the-two-distinct-phases-of-a-GitHub-Actions-Importer-migration-and-their-associated-commands.yml

updated name
…ctions-Importer-migration-and-their-associated-commands.md to 2-Learn-about-the-three-distinct-phases-of-a-GitHub-Actions-Importer-migration-and-their-associated-commands.md

Added testing phase section with specific subsection on custom transformers and changed the title of the unit.
…porter-migration-and-their-associated-commands.md

Bolded the different phases to emphasize their importance
@a-a-ron a-a-ron merged commit e09e832 into main Mar 21, 2023
@a-a-ron a-a-ron deleted the cami-actions-importer branch March 21, 2023 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants