diff --git a/1-CONTRIBUTION-GUIDE/best-practices.md b/1-CONTRIBUTION-GUIDE/best-practices.md index 0f53482e6bef..3579ad42ee43 100644 --- a/1-CONTRIBUTION-GUIDE/best-practices.md +++ b/1-CONTRIBUTION-GUIDE/best-practices.md @@ -13,7 +13,6 @@ You are currently reading the best practices. + It is a good practice to pass your template through a JSON linter to remove extraneous commas, parenthesis, brackets that may break the "Deploy to Azure" experience. Try http://jsonlint.com/ or a linter package for your favorite editing environment (Visual Studio Code, Atom, Sublime Text, Visual Studio etc.) + It's also a good idea to format your JSON for better readability. You can use a JSON formatter package for your local editor or [format online using this link](https://www.bing.com/search?q=json+formatter). -+ A starter template is provided [here](/100-STARTER-TEMPLATE-with-VALIDATION) for you to follow. The following guidelines are relevant to the main deployment template and nested templates (if used). diff --git a/1-CONTRIBUTION-GUIDE/sample-README.md b/1-CONTRIBUTION-GUIDE/sample-README.md index d037a6db6384..4d6381087ffa 100644 --- a/1-CONTRIBUTION-GUIDE/sample-README.md +++ b/1-CONTRIBUTION-GUIDE/sample-README.md @@ -1,9 +1,9 @@ # Solution name - + - + @@ -20,10 +20,10 @@ You can optionally specify a storage account to use, if so the storage account m one will be created by the script (think of this as "temp" storage for AzureRM) and reused by subsequent deployments. ```PowerShell -.\Deploy-AzureResourceGroup.ps1 -ResourceGroupLocation 'eastus' -ArtifactsStagingDirectory '100-STARTER-TEMPLATE-with-VALIDATION' -UploadArtifacts +.\Deploy-AzureResourceGroup.ps1 -ResourceGroupLocation 'eastus' -ArtifactsStagingDirectory '100-blank-template' -UploadArtifacts ``` ```bash -azure-group-deploy.sh -a 100-STARTER-TEMPLATE-with-VALIDATION -l eastus -u +azure-group-deploy.sh -a 100-blank-template -l eastus -u ``` This template deploys a **solution name**. The **solution name** is a **description**