|
| 1 | +--- |
| 2 | +title: [Follow SEO guidance at |
| 3 | +https://review.learn.microsoft.com/en-us/help/platform/seo-meta-title] |
| 4 | +description: "[Article description]." |
| 5 | +author: [your GitHub alias] |
| 6 | +ms.author: [your Microsoft alias or a team alias] |
| 7 | +ms.service: [the approved service name] |
| 8 | +ms.topic: quickstart #Don't change |
| 9 | +ms.date: [mm/dd/yyyy] |
| 10 | + |
| 11 | +#customer intent: As a <role>, I want <what> so that <why>. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +<!-- -------------------------------------- |
| 16 | +
|
| 17 | +- Use this template with pattern instructions for: |
| 18 | +
|
| 19 | +Quickstart |
| 20 | +
|
| 21 | +- Use the Quickstart pattern when you want to show a user |
| 22 | +how to complete a task to get started with a product or |
| 23 | +service in their own environment. |
| 24 | +
|
| 25 | +- Before you sign off or merge: |
| 26 | +
|
| 27 | +Remove all comments except the customer intent. |
| 28 | +
|
| 29 | +- Feedback: |
| 30 | +
|
| 31 | +https://aka.ms/patterns-feedback |
| 32 | +
|
| 33 | +--> |
| 34 | + |
| 35 | +# Quickstart: [verb] * [noun] |
| 36 | + |
| 37 | +<!-- Required: Article headline - H1 |
| 38 | +
|
| 39 | +Identify the product or service and the feature area |
| 40 | +the quickstart covers. |
| 41 | +
|
| 42 | +--> |
| 43 | + |
| 44 | +[Introduce and explain the purpose of the article.] |
| 45 | + |
| 46 | +<!-- Required: Introductory paragraphs (no heading) |
| 47 | +
|
| 48 | +Write a brief introduction that can help the user determine |
| 49 | +whether the article is relevant for them. Begin with a |
| 50 | +sentence that says, "In this quickstart, you . . . ." |
| 51 | +
|
| 52 | +--> |
| 53 | + |
| 54 | +If you don't have a service subscription, create a free |
| 55 | +trial account . . . |
| 56 | + |
| 57 | +<!-- Required: Free account links (no heading) |
| 58 | +
|
| 59 | +Because quickstarts are intended to help new customers |
| 60 | +use a product or service, include a link to a |
| 61 | +free trial before the first H2 or in the prerequisites. |
| 62 | +
|
| 63 | +--> |
| 64 | + |
| 65 | +## Prerequisites |
| 66 | + |
| 67 | +<!-- Optional: Prerequisites - H2 |
| 68 | +
|
| 69 | +If included, "Prerequisites" must be the first H2 in the article. |
| 70 | +
|
| 71 | +List any items that are needed for the quickstart, |
| 72 | +such as permissions or software. |
| 73 | +
|
| 74 | +If the user needs to sign in to a portal to do |
| 75 | +the quickstart, provide instructions and a link. |
| 76 | +
|
| 77 | +--> |
| 78 | + |
| 79 | +## Open [Cloud Shell, Azure CLI, or PowerShell] |
| 80 | + |
| 81 | +<!-- Optional: Open a demo environment - H2 |
| 82 | +
|
| 83 | +If you want to refer to using Azure Cloud Shell, |
| 84 | +the Azure CLI, or Azure PowerShell, include the |
| 85 | +instructions as a first step, after the "Prerequisites" section if prerequisites are included. |
| 86 | +
|
| 87 | +Include information about Cloud Shell only if all commands can |
| 88 | +run in Cloud Shell. |
| 89 | +
|
| 90 | +Use include files if they are available. |
| 91 | +
|
| 92 | +--> |
| 93 | + |
| 94 | +## [verb] * [noun] |
| 95 | + |
| 96 | +[Introduce a task and its role in completing the process.] |
| 97 | + |
| 98 | +<!-- Required: Tasks to complete in the process - H2 |
| 99 | +
|
| 100 | +In one or more numbered H2 sections, describe tasks that |
| 101 | +the user completes in the process the quickstart describes. |
| 102 | +
|
| 103 | +--> |
| 104 | + |
| 105 | +1. Procedure step |
| 106 | +1. Procedure step |
| 107 | +1. Procedure step |
| 108 | + |
| 109 | +<!-- Required: Steps to complete the tasks - H2 |
| 110 | +
|
| 111 | +Use ordered lists to describe how to complete tasks in |
| 112 | +the process. Be consistent when you describe how to |
| 113 | +use a method or tool to complete the task. |
| 114 | +
|
| 115 | +Code requires specific formatting. Here are a few useful |
| 116 | +examples of commonly used code blocks. Make sure to |
| 117 | +use the interactive functionality when possible. |
| 118 | +
|
| 119 | +For the CLI-based or PowerShell-based procedures, |
| 120 | +don't use bullets or numbering. |
| 121 | +
|
| 122 | +Here is an example of a code block for Java: |
| 123 | +
|
| 124 | +```java |
| 125 | +cluster = Cluster.build(new File("src/site.yaml")).create(); |
| 126 | +... |
| 127 | +client = cluster.connect(); |
| 128 | +``` |
| 129 | +
|
| 130 | +Here's a code block for the Azure CLI: |
| 131 | +
|
| 132 | +```azurecli-interactive |
| 133 | +az vm create --resource-group myResourceGroup --name myVM |
| 134 | +--image win2016datacenter --admin-username azureuser |
| 135 | +--admin-password <password> |
| 136 | +``` |
| 137 | +
|
| 138 | +This is a code block for Azure PowerShell: |
| 139 | +
|
| 140 | +```azurepowershell-interactive |
| 141 | +New-AzureRmContainerGroup -ResourceGroupName |
| 142 | +myResourceGroup -Name mycontainer |
| 143 | +-Image mcr.microsoft.com/windows/servercore/iis:nanoserver |
| 144 | +-OsType Windows -IpAddressType Public |
| 145 | +``` |
| 146 | +--> |
| 147 | + |
| 148 | +## Clean up resources |
| 149 | + |
| 150 | +<!-- Optional: Steps to clean up resources - H2 |
| 151 | +
|
| 152 | +Provide steps the user takes to clean up resources that |
| 153 | +were created to complete the article. |
| 154 | +
|
| 155 | +--> |
| 156 | + |
| 157 | +## Next step -or- Related content |
| 158 | + |
| 159 | +> [!div class="nextstepaction"] |
| 160 | +> [Next sequential article title](link.md) |
| 161 | +
|
| 162 | +-or- |
| 163 | + |
| 164 | +- [Related article title](link.md) |
| 165 | +- [Related article title](link.md) |
| 166 | +- [Related article title](link.md) |
| 167 | + |
| 168 | +<!-- Optional: Next step or Related content - H2 |
| 169 | +
|
| 170 | +Consider adding one of these H2 sections (not both): |
| 171 | +
|
| 172 | +A "Next step" section that uses 1 link in a blue box |
| 173 | +to point to a next, consecutive article in a sequence. |
| 174 | +
|
| 175 | +-or- |
| 176 | +
|
| 177 | +If the quickstart is not part of a sequence, use a |
| 178 | +"Related content" section that lists links to |
| 179 | +1 to 3 articles the user might find helpful. |
| 180 | +
|
| 181 | +--> |
| 182 | + |
| 183 | +<!-- |
| 184 | +
|
| 185 | +Remove all comments except the customer intent |
| 186 | +before you sign off or merge to the main branch. |
| 187 | +
|
| 188 | +--> |
0 commit comments