diff --git a/README.md b/README.md index 98d658fc..f36379e2 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ # Azure Resource Manager Template Toolkit (arm-ttk) -The code in this repository can be used for analyzing and testing [Azure Resource Manager Templates](https://docs.microsoft.com/en-us/azure/templates/). The tests will check a template or set of templates for coding best practices. There are some checks for simple syntactical errors but the intent is not to re-implement tests or checks that are provided by the platform (e.g. the /validate api). +The code in this repository can be used for analyzing and testing [Azure Resource Manager Templates](https://docs.microsoft.com/azure/templates/). The tests will check a template or set of templates for coding best practices. There are some checks for simple syntactical errors but the intent is not to re-implement tests or checks that are provided by the platform (e.g. the /validate api). + +>**Note:** +>Starting with the 0.10 release, [Bicep](https://github.com/Azure/bicep) now contains all of the deploymentTemplate test cases included in the TTK. We will begin moving the investment in new tests to the Bicep linter. The TTK will remain available to support available JSON and createUiDefinition scenarios. ## Using the TTK -For detailed instruction on how to use the arm-ttk, see this [readme](/arm-ttk/README.md). More information can be found in the [documentation](http://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/test-toolkit). -For a guided tutorial on the arm-ttk, check out this [MS LEARN module](https://docs.microsoft.com/en-us/learn/modules/arm-template-test/). +For detailed instruction on how to use the arm-ttk, see this [readme](/arm-ttk/README.md). More information can be found in the [documentation](http://docs.microsoft.com/azure/azure-resource-manager/templates/test-toolkit). + +For a guided tutorial on the arm-ttk, check out this [MS LEARN module](https://docs.microsoft.com/learn/modules/arm-template-test/). ## Philosophy -A little bit about the tests... These are the tests that are used to validate templates for the [Azure QuickStart Repo](https://github.com/Azure/azure-quickstart-templates) and the [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/). The purpose is to ensure a standard or consistent set of coding practices to make it easier to develop expertise using the template language (easy to read, write, debug). +A little bit about the tests... These are the tests that are used to validate templates for the [Azure QuickStart Repo](https://github.com/Azure/azure-quickstart-templates) and the [Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/). The purpose is to ensure a standard or consistent set of coding practices to make it easier to develop expertise using the template language (easy to read, write, debug). As for the type, number and nature of the tests a test should check for something in the following categories (add more as you think of them :))