lint readme

Author: nkvuong

Diff for: README.md

@@ -12,15 +12,15 @@ This set of terraform templates is designed to allow every industry practitioner
 
 What's include in this sequence of Terraform modules?
 
-#### AWS | Azure
+### AWS | Azure
 
-There are 4 main modules which can be composed together. (1-4). There is also a full end-to-end example of a workspace deployment with governance and industry quickstarts included. See the `test_aws_full_lakehouse_example` for this version. 
+There are 4 main modules which can be composed together. (1-4). There is also a full end-to-end example of a workspace deployment with governance and industry quickstarts included. See the `test_aws_full_lakehouse_example` for this version.
 
 1. Creation of Databricks-compliant VPC in `aws_base` `azure_spoke_vnet` (AWS | Azure)
 2. Platform Security Built in to Workspace deployment (Private Link, VPC endpoints, and secure connectivity) (AWS | Azure)
 3. Unity Catalog Installation (AWS | Azure)
 4. Industry Quickstarts with Sample Job and Pre-installed Libraries for Time Series, Common Domain Models
-5. Full End-to-End example (AWS) for Composition of all modules above (see below). Similarly, this works for Azure modules. 
+5. Full End-to-End example (AWS) for Composition of all modules above (see below). Similarly, this works for Azure modules.
 
 ```hcl
 module "aws_base" {

Diff for: examples/test_azure_data_exfiltration_protection/README.md

@@ -2,26 +2,28 @@
 page_title: "Provisioning Azure Databricks Hub and Spoke Deployment as per Data Exfiltration Protection with Terraform"
 ---
 
+# Provisioning Azure Databricks Hub and Spoke Deployment as per Data Exfiltration Protection with Terraform
+
 [Reference documentation and blog](https://databricks.com/blog/2020/03/27/data-exfiltration-protection-with-azure-databricks.html)
 This Terraform configuration is an implementation of the above blog post.
 Note: the firewall rules deviate slightly in that outbound traffic from the firewall is allowed to Databricks resources instead of specifying Databricks worker subnets.
 This is to simplify outbound routing in the event that multiple `spoke`s are desired.
 
-This guide is provided as-is and you can use this guide as the basis for your custom Terraform module. 
+This guide is provided as-is and you can use this guide as the basis for your custom Terraform module.
 
 It uses the following variables in configurations:
 
-### Required
+## Required
 
 - `project_name`: (Required) The name of the project associated with the infrastructure to be managed by Terraform
 - `location`: (Required) The location for the resources in this module
 - `databricks_workspace_name`: (Required) The name of the Azure Databricks Workspace to deploy in the spoke vnet
-- `scc_relay_address_prefixes`: (Required) The IP address(es) of the Databricks SCC relay (see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#control-plane-nat-and-webapp-ip-addresses)
+- `scc_relay_address_prefixes`: (Required) The IP address(es) of the Databricks SCC relay (see <https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#control-plane-nat-and-webapp-ip-addresses>)
 - `privatelink_subnet_address_prefixes`: (Required) The address prefix(es) for the PrivateLink subnet
 - `firewall_name`: (Required) The name of the Azure Firewall deployed in your hub Virtual Network
 - `firewall_private_ip`: (Required) The hub firewall's private IP address
 - `webapp_and_infra_routes`: (Required) Map of regional webapp and ext-infra CIDRs.
-   Check https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#ip-addresses for more info
+   Check <https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#ip-addresses> for more info
    Ex., for eastus:
    {
      "webapp1" : "40.70.58.221/32",
@@ -30,7 +32,7 @@ It uses the following variables in configurations:
      "ext-infra" : "20.57.106.0/28"
    }
 
-### Optional
+## Optional
 
 - `hub_resource_group_name`: (Optional) The name of the existing Resource Group containing the hub Virtual Network
 - `hub_vnet_name`: (Optional) The name of the existing hub Virtual Network

Diff for: gcp/README.md

@@ -20,14 +20,15 @@ This guide uses the following variables in configurations:
 - `zone` - Zone specified for the GCP Terraform provider
 - `network_id` - UUID which is created once the Network Configuration is created via the Databricks account console for GCP. This should be created using the IP range, secondary ranges, and Google Compute Network is created.
 
-This guide is provided as-is and you can use this guide as the basis for your custom Terraform module. Note that for BYO VPC (a.k.a. customer managed VPC), there is a 2-step process as full automation via the tradition `databricks_mws_networks` is not supported at this time for GCP. 
+This guide is provided as-is and you can use this guide as the basis for your custom Terraform module. Note that for BYO VPC (a.k.a. customer managed VPC), there is a 2-step process as full automation via the tradition `databricks_mws_networks` is not supported at this time for GCP.
 
-Workaround: 
+Workaround:
 
-1. Run `apply` without the workspace.tf file to create all infrastructure and Databricks-compliant VPC with Cloud NAT. 
+1. Run `apply` without the workspace.tf file to create all infrastructure and Databricks-compliant VPC with Cloud NAT.
 2. Run `apply` with workspace.tf to create the workspace once the `network_id` (see description above in variables) is created with the GCP accounts console (Cloud Resouces).
 
 To get started, this code walks you through the following high-level steps:
+
 - Initialize the required providers
 - Configure GCP objects
   - A VPC which satisfies the Databricks GCP networking [requirements](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/customer-managed-vpc.html#network-requirements-1)

Diff for: modules/aws_base/README.md

@@ -2,6 +2,7 @@
 page_title: "Create an AWS Databricks-compatible VPC using Terraform"
 ---
 
+# Create an AWS Databricks-compatible VPC using Terraform
 
 This module uses the following input variables. Please all variables here in a terraform.tfvars file (outside the github project) and reference it using `terraform apply -var-file="<location for tfvars file>/terraform.tfvars"`.
 
@@ -22,7 +23,6 @@ This module uses the following input variables. Please all variables here in a t
 - `cross_account_role_arn` - Cross-account role ARN for deploying Databricks workspace
 - `root_bucket` - Name of S3 bucket used as Databricks root bucket
 
-
 ```hcl
 module "aws_base" {
   source = "databricks/aws_base/"

Diff for: modules/aws_fs_lakehouse/README.md

@@ -2,6 +2,7 @@
 page_title: "Create Resources in Existing Databricks Workspace and Configure Storage, Jobs, IP Access Lists, and Library Installation"
 ---
 
+# Create Resources in Existing Databricks Workspace and Configure Storage, Jobs, IP Access Lists, and Library Installation
 
 This module uses the following input variables. Please all variables here in a terraform.tfvars file (outside the github project) and reference it using `terraform apply -var-file="<location for tfvars file>/terraform.tfvars"`.
 

Diff for: modules/aws_full_governed_ws/README.md

@@ -2,10 +2,10 @@
 page_title: "Create Cloud Resources for Unity Catalog, Assign Metastores, and Create Sample Catalog"
 ---
 
+# Create Cloud Resources for Unity Catalog, Assign Metastores, and Create Sample Catalog
 
 This module uses the following input variables. Please all variables here in a terraform.tfvars file (outside the github project) and reference it using `terraform apply -var-file="<location for tfvars file>/terraform.tfvars"`.
 
-
 ## Input Variables
 
 - `databricks_account_id`: The ID per Databricks AWS account used for accessing account management APIs. After the AWS E2 account is created, this is available after logging into [https://accounts.cloud.databricks.com](https://accounts.cloud.databricks.com).
@@ -18,6 +18,7 @@ This module uses the following input variables. Please all variables here in a t
 - `databricks_users` - List of all Databricks users which should be provisioned as part of the quickstart. This is mostly instructive and the best practice should be to use SCIM to sync users to the Databricks workspace - terraform can be used for the assignment (assuming users already exist)
 - `databricks_metastore_admins` - List of all metastore admins to be added to the Databricks group
 - `unity_admin_group` - Name of the group to be used as the admins for metastore, catalog, schema, and databases. This should be restricted to a small group of users with to administrate UC APIs.
+
 ```hcl
 module "aws_full_governed_ws" {
   source = "databricks/aws_full_governed_ws/"

Diff for: modules/azure_spoke_vnet/README.md

@@ -2,6 +2,8 @@
 page_title: "Provisioning Azure Spoke VNET as per Data Exfiltration Protection with Terraform"
 ---
 
+# Provisioning Azure Spoke VNET as per Data Exfiltration Protection with Terraform
+
 [Reference documentation and blog](https://databricks.com/blog/2020/03/27/data-exfiltration-protection-with-azure-databricks.html)
 
 This guide uses the following variables in configurations:
@@ -15,10 +17,10 @@ This guide uses the following variables in configurations:
 - `spoke_resource_group_name` - (Required) The name of the Resource Group to create
 - `project_name` - (Required) The name of the project associated with the infrastructure to be managed by Terraform
 - `spoke_vnet_address_space` - (Required) The address space for the spoke Virtual Network
-- `scc_relay_address_prefixes` - (Required) The IP address(es) of the Databricks SCC relay (see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#control-plane-nat-and-webapp-ip-addresses)
+- `scc_relay_address_prefixes` - (Required) The IP address(es) of the Databricks SCC relay (see <https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#control-plane-nat-and-webapp-ip-addresses>)
 - `privatelink_subnet_address_prefixes` - (Required) The address prefix(es) for the PrivateLink subnet
 - `webapp_and_infra_routes` - (Required) Map of regional webapp and ext-infra CIDRs.
-   Check https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#ip-addresses for more info
+   Check <https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr#ip-addresses> for more info
    Ex., for eastus:
    {
      "webapp1" : "40.70.58.221/32",

Diff for: modules/azure_vnet_injected_databricks_workspace/README.md

@@ -2,7 +2,7 @@
 page_title: "Provisioning Azure Databricks Workspaces with Private Link and Data Exfiltration Protection with Terraform"
 ---
 
-# How to Deploy a Secure Azure Databricks Workspace, Hardened To Prevent Data Exfiltration.
+# How to Deploy a Secure Azure Databricks Workspace, Hardened To Prevent Data Exfiltration
 
 This guide uses the following variables in configurations: