Update course format for accessibility

skills · May 30, 2023 · 29c7f69 · 29c7f69
1 parent 0b429c0
commit 29c7f69
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 88 deletions.
diff --git a/.github/script/STEP → .github/steps/-step.txt b/.github/script/STEP → .github/steps/-step.txt
diff --git a/.github/steps/0-welcome.md b/.github/steps/0-welcome.md
@@ -0,0 +1 @@
+<!-- readme -->
diff --git a/.github/workflows/0-start.yml → .github/workflows/0-welcome.yml b/.github/workflows/0-start.yml → .github/workflows/0-welcome.yml
@@ -1,18 +1,17 @@
-name: Step 0, Start
+name: Step 0, Welcome
 
 # This step triggers after the learner creates a new repository from the template
-# This step sets STEP to 1
-# This step closes <details id=0> and opens <details id=1>
+# This workflow updates from step 0 to step 1.
 
 # This will run every time we create push a commit to `main`
-# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
 on:
  workflow_dispatch:
  push:
  branches:
  - main
 
-# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
 permissions:
  # Need `contents: read` to checkout the repository
  # Need `contents: write` to update the step metadata
@@ -21,7 +20,7 @@ permissions:
  pull-requests: write
 
 jobs:
- # Get the current step from .github/script/STEP so we can
+ # Get the current step from .github/steps/-step.txt so we can
  # limit running the main job when the learner is on the same step.
  get_current_step:
  name: Check current step number
@@ -31,7 +30,7 @@ jobs:
  uses: actions/checkout@v3
  - id: get_step
  run: |
- echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT
+ echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT
  outputs:
  current_step: ${{ steps.get_step.outputs.current_step }}
 
@@ -41,9 +40,9 @@ jobs:
 
  # We will only run this action when:
  # 1. This repository isn't the template repository
- # 2. The STEP is currently 0
- # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
- # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
+ # 2. The step is currently 0
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions
  if: >-
  ${{ !github.event.repository.is_template
  && needs.get_current_step.outputs.current_step == 0 }}
@@ -62,7 +61,7 @@ jobs:
  - name: Prepare a pull request, branch, and file
  run: |
  echo "Make sure we are on step 0"
- if [ "$(cat .github/script/STEP)" != 0 ]
+ if [ "$(cat .github/steps/-step.txt)" != 0 ]
  then
  echo "Current step is not 0"
  exit 0
@@ -89,10 +88,9 @@ jobs:
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
- # Update README to close <details id=0> and open <details id=1>
- # and set STEP to '1'
- - name: Update to step 1
- uses: skills/action-update-step@v1
+ # In README.md, switch step 0 for step 1.
+ - name: Update to step 1
+ uses: skills/action-update-step@v2
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  from_step: 0

diff --git a/.github/workflows/1-add-headers.yml b/.github/workflows/1-add-headers.yml
@@ -1,25 +1,24 @@
 name: Step 1, Add headers
 
 # This step triggers after a commit on the branch `start-markdown`
-# This step sets STEP to 2
-# This step closes <details id=1> and opens <details id=2>
+# This workflow updates from step 1 to step 2.
 
 # This will run every time we create push a commit to `start-markdown`
-# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
 on:
  workflow_dispatch:
  push:
  branches:
  - start-markdown
 
-# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
 permissions:
  # Need `contents: read` to checkout the repository
  # Need `contents: write` to update the step metadata
  contents: write
 
 jobs:
- # Get the current step from .github/script/STEP so we can
+ # Get the current step from .github/steps/-step.txt so we can
  # limit running the main job when the learner is on the same step.
  get_current_step:
  name: Check current step number
@@ -29,7 +28,7 @@ jobs:
  uses: actions/checkout@v3
  - id: get_step
  run: |
- echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT
+ echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT
  outputs:
  current_step: ${{ steps.get_step.outputs.current_step }}
 
@@ -39,9 +38,9 @@ jobs:
 
  # We will only run this action when:
  # 1. This repository isn't the template repository
- # 2. The STEP is currently 1
- # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
- # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
+ # 2. The step is currently 1
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions
  if: >-
  ${{ !github.event.repository.is_template
  && needs.get_current_step.outputs.current_step == 1 }}
@@ -63,10 +62,9 @@ jobs:
  FILE: "index.md"
  SEARCH: "# [a-zA-Z0-9]"
 
- # Update README to close <details id=1> and open <details id=2>
- # and set STEP to '2'
- - name: Update to step 2
- uses: skills/action-update-step@v1
+ # In README.md, switch step 1 for step 2.
+ - name: Update to step 2
+ uses: skills/action-update-step@v2
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  from_step: 1

diff --git a/.github/workflows/2-add-an-image.yml b/.github/workflows/2-add-an-image.yml
@@ -1,25 +1,24 @@
 name: Step 2, Add an image
 
 # This step triggers after a commit on the branch `start-markdown`
-# This step sets STEP to 3
-# This step closes <details id=2> and opens <details id=3>
+# This workflow updates from step 2 to step 3.
 
 # This will run every time we create push a commit to `start-markdown`
-# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
 on:
  workflow_dispatch:
  push:
  branches:
  - start-markdown
 
-# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
 permissions:
  # Need `contents: read` to checkout the repository
  # Need `contents: write` to update the step metadata
  contents: write
 
 jobs:
- # Get the current step from .github/script/STEP so we can
+ # Get the current step from .github/steps/-step.txt so we can
  # limit running the main job when the learner is on the same step.
  get_current_step:
  name: Check current step number
@@ -29,7 +28,7 @@ jobs:
  uses: actions/checkout@v3
  - id: get_step
  run: |
- echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT
+ echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT
  outputs:
  current_step: ${{ steps.get_step.outputs.current_step }}
 
@@ -39,9 +38,9 @@ jobs:
 
  # We will only run this action when:
  # 1. This repository isn't the template repository
- # 2. The STEP is currently 2
- # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
- # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
+ # 2. The step is currently 2
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions
  if: >-
  ${{ !github.event.repository.is_template
  && needs.get_current_step.outputs.current_step == 2 }}
@@ -63,10 +62,9 @@ jobs:
  FILE: "index.md"
  SEARCH: "\\!\\[.*](.*)"
 
- # Update README to close <details id=2> and open <details id=3>
- # and set STEP to '3'
- - name: Update to step 3
- uses: skills/action-update-step@v1
+ # In README.md, switch step 2 for step 3.
+ - name: Update to step 3
+ uses: skills/action-update-step@v2
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  from_step: 2

diff --git a/.github/workflows/3-add-a-code-example.yml b/.github/workflows/3-add-a-code-example.yml
@@ -1,25 +1,24 @@
 name: Step 3, Add a code example
 
 # This step triggers after a commit on the branch `start-markdown`
-# This step sets STEP to 4
-# This step closes <details id=3> and opens <details id=4>
+# This workflow updates from step 3 to step 4.
 
 # This will run every time we create push a commit to `start-markdown`
-# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
 on:
  workflow_dispatch:
  push:
  branches:
  - start-markdown
 
-# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
 permissions:
  # Need `contents: read` to checkout the repository
  # Need `contents: write` to update the step metadata
  contents: write
 
 jobs:
- # Get the current step from .github/script/STEP so we can
+ # Get the current step from .github/steps/-step.txt so we can
  # limit running the main job when the learner is on the same step.
  get_current_step:
  name: Check current step number
@@ -29,7 +28,7 @@ jobs:
  uses: actions/checkout@v3
  - id: get_step
  run: |
- echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT
+ echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT
  outputs:
  current_step: ${{ steps.get_step.outputs.current_step }}
 
@@ -39,9 +38,9 @@ jobs:
 
  # We will only run this action when:
  # 1. This repository isn't the template repository
- # 2. The STEP is currently 3
- # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
- # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
+ # 2. The step is currently 3
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions
  if: >-
  ${{ !github.event.repository.is_template
  && needs.get_current_step.outputs.current_step == 3 }}
@@ -63,10 +62,9 @@ jobs:
  FILE: "index.md"
  SEARCH: "\\`\\`\\`"
 
- # Update README to close <details id=3> and open <details id=4>
- # and set STEP to '4'
- - name: Update to step 4
- uses: skills/action-update-step@v1
+ # In README.md, switch step 3 for step 4.
+ - name: Update to step 4
+ uses: skills/action-update-step@v2
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  from_step: 3

diff --git a/.github/workflows/4-make-a-task-list.yml b/.github/workflows/4-make-a-task-list.yml
@@ -1,25 +1,24 @@
 name: Step 4, Make a task list
 
 # This step triggers after a commit on the branch `start-markdown`
-# This step sets STEP to 5
-# This step closes <details id=4> and opens <details id=5>
+# This workflow updates from step 4 to step 5.
 
 # This will run every time we create push a commit to `start-markdown`
-# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
+# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
 on:
  workflow_dispatch:
  push:
  branches:
  - start-markdown
 
-# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
 permissions:
  # Need `contents: read` to checkout the repository
  # Need `contents: write` to update the step metadata
  contents: write
 
 jobs:
- # Get the current step from .github/script/STEP so we can
+ # Get the current step from .github/steps/-step.txt so we can
  # limit running the main job when the learner is on the same step.
  get_current_step:
  name: Check current step number
@@ -29,7 +28,7 @@ jobs:
  uses: actions/checkout@v3
  - id: get_step
  run: |
- echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT
+ echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT
  outputs:
  current_step: ${{ steps.get_step.outputs.current_step }}
 
@@ -39,9 +38,9 @@ jobs:
 
  # We will only run this action when:
  # 1. This repository isn't the template repository
- # 2. The STEP is currently 4
- # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
- # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
+ # 2. The step is currently 4
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts
+ # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions
  if: >-
  ${{ !github.event.repository.is_template
  && needs.get_current_step.outputs.current_step == 4 }}
@@ -63,10 +62,9 @@ jobs:
  FILE: "index.md"
  SEARCH: "\\- \\[ ] "
 
- # Update README to close <details id=4> and open <details id=5>
- # and set STEP to '5'
- - name: Update to step 5
- uses: skills/action-update-step@v1
+ # In README.md, switch step 4 for step 5.
+ - name: Update to step 5
+ uses: skills/action-update-step@v2
  with:
  token: ${{ secrets.GITHUB_TOKEN }}
  from_step: 4