From 5b39cffcbdbf7e1c8fff3499b717070996f0212b Mon Sep 17 00:00:00 2001 From: "Brian Moore (AZURE RESOURCE MANAGER)" Date: Mon, 6 Aug 2018 13:36:39 -0500 Subject: [PATCH] updates to BP guide --- 1-CONTRIBUTION-GUIDE/best-practices.md | 3 ++- 1-CONTRIBUTION-GUIDE/bp-checklist.md | 37 -------------------------- 2 files changed, 2 insertions(+), 38 deletions(-) delete mode 100644 1-CONTRIBUTION-GUIDE/bp-checklist.md diff --git a/1-CONTRIBUTION-GUIDE/best-practices.md b/1-CONTRIBUTION-GUIDE/best-practices.md index fe0b8d551bec..c60d52823482 100644 --- a/1-CONTRIBUTION-GUIDE/best-practices.md +++ b/1-CONTRIBUTION-GUIDE/best-practices.md @@ -267,7 +267,8 @@ The following code shows an example: "metadata": { "description": "The base URI where artifacts required by this template are located including a trailing '/'" }, - "defaultValue": "[deployment().properties.templateLink.uri]" + "defaultValue": "[deployment().properties.templateLink.uri]", //use this for the Azure marketplace + "defaultValue": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/[name of sample folder]" // use this for a Quickstart in this repo (we're working on fixing this...) }, "_artifactsLocationSasToken": { "type": "securestring", diff --git a/1-CONTRIBUTION-GUIDE/bp-checklist.md b/1-CONTRIBUTION-GUIDE/bp-checklist.md deleted file mode 100644 index 2db1ba6acd62..000000000000 --- a/1-CONTRIBUTION-GUIDE/bp-checklist.md +++ /dev/null @@ -1,37 +0,0 @@ -# Azure Resource Manager Templates - Best Practice Checklist - -Use this as a quick checklist to ensure your sample meets the minimum set of guidelines for samples in this repository. For the full set and a detailed explanation see the [**Best Practices Guide**](/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices). - -These practices ensure your sample provides a consistent, reliable experience across all Azure Clouds. - -## Checklist - -1. All uri's should be compatible with all clouds (Stack, China, Government) - + See #9 in [**Best practices**](/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices) - -2. For staging artifacts (scripts, templates, etc) use paramters named _artifactsLocation & _artifactsLocationSasToken - see: - + [**Samples that contain artifacts**](https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/best-practices.md#samples-that-contain-extra-artifacts-custom-scripts-nested-templates-etc) - -3. Use resourceGroup().location for resource locations to be compatible with all clouds - + Exceptions for resources that are available on only a few locations (which is not the same as !global) - + If a location param is needed do not use parameters named "location", instead resourceLocation or storageLocation, etc. - -4. Folder names for artifacts: - + nestedtemplates - + scripts - + DSC - -5. Use literal values for apiVersion (do not variables so schema validation can be done) - -6. Parameter files must not contain values like "changemeplease" - use default values when appropriate in the template file and leave them out of param files - -7. Check whether $schema entries in templates and parameter files are the latest (2015-01-01) and using https - -8. Update the metadata.json with the current date - -9. Use uniqueString() whenever possible to generate names for resources. While this is not required, it's one of the most common failure points in a deployment. - ---- - -### Final Note -If you're submitting a developer sample (101/201/301 level template), use the full best practice guide to ensure the full list of practices have been followed.