From 5a7888ffc7be1c93c74318ec54b15de44836c811 Mon Sep 17 00:00:00 2001 From: Robert Balent Date: Sat, 6 Oct 2018 22:23:53 -0700 Subject: [PATCH] Fixing typos in contribution guide readme --- 1-CONTRIBUTION-GUIDE/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/1-CONTRIBUTION-GUIDE/README.md b/1-CONTRIBUTION-GUIDE/README.md index 682b70796cef..147a3f30f76d 100644 --- a/1-CONTRIBUTION-GUIDE/README.md +++ b/1-CONTRIBUTION-GUIDE/README.md @@ -83,7 +83,7 @@ The README.md describes your deployment. A good description helps other communit + Deploy to Azure button + Visualize button + Description of what the template will deploy -+ Tags, that can be used for search. Specify the tags comma seperated and enclosed between two back-ticks (e.g Tags: `cluster, ha, sql`) ++ Tags, that can be used for search. Specify the tags comma separated and enclosed between two back-ticks (e.g Tags: `cluster, ha, sql`) + *Optional: Prerequisites + *Optional: Description on how to use the application + *Optional: Notes @@ -229,8 +229,8 @@ If your template has some pre-requisite such as existing Virtual Network or stor + Create a folder named `prereqs ` in root of your template folder, Store pre-requisite template file, parameters file and artifacts inside this folder. + Store pre-requisite template file with name `prereq.azuredeploy.json ` and parameters files with name `prereq.azuredeploy.parameters.json` -+ `prereq.azuredeploy.json` should deploy all required pre-existing resources by your main template and also output the values required by main template to leverage those resources. For example, if your template needs an existing VNET to be available prior to the deployment of main template, you should develop a pre-req template which deployes a VNET and outputs the VNET ID or VNET name of the virtual network created. -+ In order to use the values generated by outputs after deployment of `prereq.azuredeploy.json`, you will need to define parameter values as `GET-PREREQ-OutputName`. For exmaple, if you generated a output with name `vnetID` in pre-req template, in order use the value of this output in main template, enter the value of corresponding parameter in main template parameters file as `GET-PREREQ-vnetID` ++ `prereq.azuredeploy.json` should deploy all required pre-existing resources by your main template and also output the values required by main template to leverage those resources. For example, if your template needs an existing VNET to be available prior to the deployment of main template, you should develop a pre-req template which deploys a VNET and outputs the VNET ID or VNET name of the virtual network created. ++ In order to use the values generated by outputs after deployment of `prereq.azuredeploy.json`, you will need to define parameter values as `GET-PREREQ-OutputName`. For example, if you generated a output with name `vnetID` in pre-req template, in order use the value of this output in main template, enter the value of corresponding parameter in main template parameters file as `GET-PREREQ-vnetID` + Check out this [sample template](https://github.com/Azure/azure-quickstart-templates/tree/master/101-subnet-add-vnet-existing) to learn more If your template has some pre-requisite such as an Azure Active Directory application or service principal, we don't support this yet. To bypass the CI workflow include a file called .ci_skip in the root of your template folder.