Formatting updates for consistency

skills · May 31, 2023 · 6d6afff · 6d6afff
1 parent 42ba367
commit 6d6afff
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 0 deletions.
diff --git a/.github/steps/1-configure-label-based-job.md b/.github/steps/1-configure-label-based-job.md
@@ -1,3 +1,11 @@
+<!--
+  <<< Author notes: Step 1 >>>
+  Choose 3-5 steps for your course.
+  The first step is always the hardest, so pick something easy!
+  Link to docs.github.com for further explanations.
+  Encourage users to open new tabs for steps!
+-->
+
 ## Step 1: Trigger a job based on labels
 
 _Welcome to the course :tada:_

diff --git a/.github/steps/2-setup-azure-environment.md b/.github/steps/2-setup-azure-environment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 2 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 2: Set up an Azure environment
 
 _Good job getting started :gear:_

diff --git a/.github/steps/3-spinup-environment.md b/.github/steps/3-spinup-environment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 3 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 3: Spin up an environment based on labels
 
 _Nicely done! :heart:_

diff --git a/.github/steps/4-deploy-to-staging-environment.md b/.github/steps/4-deploy-to-staging-environment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 4 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 4: Deploy to a staging environment based on labels
 
 _Nicely done, you used a workflow to spin up your Azure environment :dancer:_

diff --git a/.github/steps/5-deploy-to-prod-environment.md b/.github/steps/5-deploy-to-prod-environment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 5 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 5: Deploy to a production environment based on labels
 
 _Deployed! :ship:_

diff --git a/.github/steps/6-destroy-azure-environment.md b/.github/steps/6-destroy-azure-environment.md
@@ -1,3 +1,9 @@
+<!--
+  <<< Author notes: Step 6 >>>
+  Start this step by acknowledging the previous step.
+  Define terms and link to docs.github.com.
+-->
+
 ## Step 6: Production deployment
 
 _Nice work! :sparkle:_