|
| 1 | +--- |
| 2 | +lab: |
| 3 | + title: 'Exercise Title' |
| 4 | +--- |
| 5 | +<!-- |
| 6 | +Edit the metadata above to manage the list of exercises in the home page of the GitHub site that gets generated. |
| 7 | +You can delete the module and edit index.md in the root of the repo to customize the display so that only the exercises are listed |
| 8 | +To enable GitHub page publishing, edit the Page settings for the repo and publish from the main branch |
| 9 | +--> |
| 10 | + |
| 11 | +# Exercise title <!-- match title in metadata above (and Learn Exercise unit and ILT slide)--> |
| 12 | + |
| 13 | +In this exercise you will <!-- provide a description of what they'll do and why it;s important --> |
| 14 | + |
| 15 | +This exercise should take approximately **XX** minutes to complete. <!-- update with estimated duration --> |
| 16 | + |
| 17 | +## Before you start |
| 18 | + |
| 19 | +<!-- |
| 20 | +Add steps to get the learner to the starting point" for the exercise. |
| 21 | +This might be cloning the repo and running a script or performing some manual steps. |
| 22 | +Only include this section if its necessary to do some pre-exercise setup AND the same setup steps are required for self-paced (on Learn) and managed (in hosted ILT lab profiles) scenarios. Otherwise delete this section. |
| 23 | +If self-paced /ILT-specific setup steps are required, include them in the Learn "Exercise" unit from where they open this exercise and in the Skillable lab profile instructions before this markdown file is imported. |
| 24 | + --> |
| 25 | + |
| 26 | +Before you can start this exercise, you will need to... |
| 27 | + |
| 28 | +1. Step 1 |
| 29 | +1. Step 2 |
| 30 | +1. etc. |
| 31 | + |
| 32 | +## Task <!-- Change to an appropriate task title with an imperative verb phrase (e.g. "Do something") --> |
| 33 | + |
| 34 | +First, you need to ... |
| 35 | + |
| 36 | +1. Step 1 |
| 37 | +1. This step includes an example of `inline code formatting`, which is used when the learner needs to type something (anything, not just code) because it creates a [T] link in the hosted Skillable environment. |
| 38 | +1. If you need the learner to open a website, include both a link (so they can open by clicking in the HTML GitHub page) AND the URL formatted as code (so they can type it in a hosted VM browser). For example, "Open the [Bing](https://www.bing.com) website at `https://www.bing.com`". |
| 39 | +1. If you need the learner to download a file (or a bunch of files in a zip), store the file in Allfiles folder in this repo and use the **raw** URL - like this: "Download [file name](https://raw.githubusercontent.com/MicrosoftLearning/INF99X-SampleCourse/master/Allfiles/Labs/01/Starter/azuredeploy.json) from `https://raw.githubusercontent.com/MicrosoftLearning/INF99X-SampleCourse/master/Allfiles/Labs/01/Starter/azuredeploy.json`. |
| 40 | +1. Alternatively, for a developer audience, you can have them clone this repo if that seems more appropriate. |
| 41 | +1. If you need to include a multiline code block, indent it to match the bulleted list indent: |
| 42 | + |
| 43 | + ```python |
| 44 | + # This is an example of an |
| 45 | + # indented code block. |
| 46 | + ``` |
| 47 | + |
| 48 | +1. If you need to include a acreenshot, resize it to an appropriate size (so any "normal" formatted text in a partial screenshot is roughly the same size as this text - generally try to make screenshots of full application windows 800x600px (approx)). Store images in a **Media** subfolder and use markdown to add it to the page (remembering that file and folder names are case-sensitive). If the image is in a list, indent it, like this: |
| 49 | + |
| 50 | +  |
| 51 | + |
| 52 | +1. If you need to explain why something is done the way it is, or provide additional context or links to info, use a note like this: |
| 53 | + |
| 54 | + > **Note**: This is a note. |
| 55 | + |
| 56 | +1. Be flexible when providing instructions that might vary between self-paced and hosted lab environments. For example: |
| 57 | + - "Sign in using your Azure credentials" (assuming there were Learn-specific instructions to use a personal subscription or create a trial in the Learn exercise page, and ILT-specific instructions to use provided cloudslice credentials in the Skillable lab profile) |
| 58 | + - "Select an existing resource group or create a new one" (assuming that if a Skillable CS-R cloudslice is used, you included a note in the lab profile telling the learner which resource group they should use) |
| 59 | + <!-- The key point is that this markdown file should be environment-agnostic - you need to provide explicit details of things that can vary OUTSIDE of this file (in the Learn exercise page or the Skillable lab profile instructions) --> |
| 60 | +1. etc. |
| 61 | + |
| 62 | +## Next task |
| 63 | + |
| 64 | +Now let's, ... |
| 65 | + |
| 66 | +1. Step 1 |
| 67 | +1. Step 2 |
| 68 | +1. etc. |
| 69 | + |
| 70 | +## Task with subtasks |
| 71 | + |
| 72 | +Sometimes you might want to break a taak down into smaller chunks. |
| 73 | + |
| 74 | +### Subtask 1 |
| 75 | + |
| 76 | +1. Step 1 |
| 77 | +1. Step 2 |
| 78 | +1. Etc. |
| 79 | + |
| 80 | +### Subtask 2 |
| 81 | + |
| 82 | +1. Step 1 |
| 83 | +1. Step 2 |
| 84 | +1. etc. |
| 85 | + |
| 86 | +## Clean up |
| 87 | + |
| 88 | +<!-- Good practice - especially as self-paced learners will be using their own subscriptions --> |
| 89 | +<!-- Delete this section if it is not needed --> |
| 90 | + |
| 91 | +Now that you've finished the exercise, you should delete the cloud resources you've created to avoid unnecessary resource usage. |
| 92 | + |
| 93 | +1. Step 1 |
| 94 | +2. etc. |
0 commit comments