Update README and precommit

Azure · Feb 11, 2022 · a21b7cb · a21b7cb
1 parent 21f4224
commit a21b7cb
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 31 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,7 +2,7 @@
 # See http://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: git://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.62.3
+    rev: v1.64.0
     hooks:
     - id: terraform_fmt
     - id: terraform_docs
@@ -14,8 +14,13 @@ repos:
     hooks:
       - id: check-merge-conflict
       - id: trailing-whitespace
-    #  - id: check-yaml
+      # - id: check-yaml
+      - id: detect-private-key
       - id: check-added-large-files
+  # - repo: git://github.com/ansible-community/ansible-lint
+  #   rev: v5.3.2
+  #   hooks:
+  #     - id: ansible-lint
   # - repo: git://github.com/markdownlint/markdownlint
   #   rev: v0.9.0
   #   hooks:

diff --git a/README.md b/README.md
@@ -6,46 +6,27 @@
 
 Microsoft [Cloud Adoption Framework for Azure](https://docs.microsoft.com/azure/cloud-adoption-framework/overview) provides you with guidance and best practices to adopt Azure.
 
-A landing zone is a segment of a cloud environment, that has been pre-provisioned through code, and is dedicated to the support of one or more workloads. Landing zones provide access to foundational tools and controls to establish a compliant place to innovate and build new workloads in the cloud, or to migrate existing workloads to the cloud. Landing zones use defined sets of cloud services and best practices to set you up for success.
+CAF Terraform landing zones team mission statement is to:
 
-We leverage Azure enterprise-scale landing zones and propose a Terraform-native structure, set of mechanisms and artifacts to get started to deploy workloads fast. 
+* Equip the Site Reliability Engineering teams for Terraform on Azure.
+* Democratize an IaC: Infrastructure-as-Configuration.
+* Commoditize state management and enterprise-wide composition.
+* Standardize deployments using Azure enterprise-scale landing zones.
+* Implement Azure enterprise-scale design and approach with native Terraform and DevOps.
+* Propose a prescriptive guidance on how to enable DevOps for infrastructure as code on Microsoft Azure.
+* Foster a community of Azure *Terraformers* using a common set of practices and sharing best practices.
 
 You can review the different components parts of the Cloud Adoption Framework for Azure Terraform landing zones and look at the quick intro :vhs:  below:
 
 [![caf_elements](./_pictures/caf_elements.png)](https://www.youtube.com/watch?v=FlQ17u4NNts "CAF Introduction")
 
-## Goals
-
-Cloud Adoption Framework for Azure Terraform landing zones is an Open Source project equiping the Site Reliability Engineer on Azure with:
-
-* Enable the community with a set of reusable landing artifacts.
-* Standardize deployments using battlefield-proven components.
-* Accelerate the setup of complex environments on Azure.
-* Implement Azure enterprise-scale design and approach with native Terraform and DevOps.
-* Propose a prescriptive guidance on how to enable DevOps for infrastructure as code on Microsoft Azure.
-* Foster a community of Azure *Terraformers* using a common set of practices and sharing best practices.
-
 ## :rocket: Getting started
 
 When starting an enterprise deployment, we recommend you start creating a configuration repository where you craft the configuration files for your environments.
 
-The best way to start is to clone the [starter repository](https://github.com/Azure/caf-terraform-landingzones-starter) and getting started with the configuration files, you can find a quick [onboarding video here](https://www.youtube.com/watch?v=M5BXm30IpdY)
-
-## Documentation
-
-The documentation on this repo is  on how to develop, deploy and operate with landing zones can be found in the reference section [here](./documentation/README.md)
-
-## Repositories
-
-In CAF Terraform landing zones, we use multiple projects in a modular way so you can leverage all of them or some of them depending on where you are in your DevOps and GitOps journey. The main repositories are listed below, feel free to evaluate, use them and contribute to them also!
+The best way to start is to clone the [platform starter repository](https://github.com/Azure/caf-terraform-landingzones-platform-starter) and getting started with the configuration files. If you are reading this, you are probably interested also in reading the doc as below:
 
-| Repo                                                                                              | Description                                                |
-|---------------------------------------------------------------------------------------------------|------------------------------------------------------------|
-| [starter kit](https://github.com/azure/caf-terraform-landingzones-starter)                        | landing zones configuration repository                     |
-| [caf-terraform-landingzones](https://github.com/azure/caf-terraform-landingzones) (You are here!) | landing zones repo with sample and core documentations     |
-| [rover](https://github.com/aztfmod/rover)                                                         | devops toolset for operating landing zones                 |
-| [azure_caf_provider](https://github.com/aztfmod/terraform-provider-azurecaf)                      | custom provider for naming conventions                     |
-| [module](https://github.com/aztfmod/terraform-azurerm-caf)                                        | CAF universal module available in the Terraform registry   |
+:books: Read our [centralized documentation page](https://aka.ms/caf/terraform)
 
 ## Community