Documentation fixes (#1696)

* Fix format arguments
* fix typos
* format docs

Author: alexott

docs/data-sources/job.md

@@ -35,4 +35,4 @@ This data source exports the following attributes:
 The following resources are used in the same context:
 
 * [databricks_jobs](jobs.md) data to get all jobs and their names from a workspace.
-* [databricks_job](../resources/job.md) to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a [databricks_cluster](../resources/cluster.md).
+* [databricks_job](../resources/job.md) to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a [databricks_cluster](../resources/cluster.md).

docs/data-sources/share.md

@@ -11,7 +11,7 @@ Getting details of an existing share in the metastore
 
 ```hcl
 data "databricks_share" "this" {
-  name = "this
+  name = "this"
 }
 
 output "created_by" {

docs/guides/aws-private-link-workspace.md

@@ -216,23 +216,23 @@ resource "aws_security_group" "dataplane_vpce" {
 
 ```hcl
 resource "aws_vpc_endpoint" "backend_rest" {
-  vpc_id             = var.vpc_id
-  service_name       = var.workspace_vpce_service
-  vpc_endpoint_type  = "Interface"
-  security_group_ids = [aws_security_group.dataplane_vpce.id]
-  subnet_ids         = [aws_subnet.dataplane_vpce.id]
+  vpc_id              = var.vpc_id
+  service_name        = var.workspace_vpce_service
+  vpc_endpoint_type   = "Interface"
+  security_group_ids  = [aws_security_group.dataplane_vpce.id]
+  subnet_ids          = [aws_subnet.dataplane_vpce.id]
   private_dns_enabled = var.private_dns_enabled
-  depends_on = [aws_subnet.dataplane_vpce]
+  depends_on          = [aws_subnet.dataplane_vpce]
 }
 
 resource "aws_vpc_endpoint" "relay" {
-  vpc_id             = var.vpc_id
-  service_name       = var.relay_vpce_service
-  vpc_endpoint_type  = "Interface"
-  security_group_ids = [aws_security_group.dataplane_vpce.id]
-  subnet_ids         = [aws_subnet.dataplane_vpce.id]
+  vpc_id              = var.vpc_id
+  service_name        = var.relay_vpce_service
+  vpc_endpoint_type   = "Interface"
+  security_group_ids  = [aws_security_group.dataplane_vpce.id]
+  subnet_ids          = [aws_subnet.dataplane_vpce.id]
   private_dns_enabled = var.private_dns_enabled
-  depends_on = [aws_subnet.dataplane_vpce]
+  depends_on          = [aws_subnet.dataplane_vpce]
 }
 
 resource "databricks_mws_vpc_endpoint" "backend_rest_vpce" {

docs/guides/unity-catalog-azure.md

@@ -262,8 +262,8 @@ resource "databricks_external_location" "some" {
   name = "external"
   url = format("abfss://%s@%s.dfs.core.windows.net/",
     azurerm_storage_container.ext_storage.name,
-    azurerm_storage_account.ext_storage.name)
-  
+  azurerm_storage_account.ext_storage.name)
+
   credential_name = databricks_storage_credential.external.id
   comment         = "Managed by TF"
   depends_on = [

docs/resources/cluster.md

@@ -88,7 +88,7 @@ When you [create a Databricks cluster](https://docs.databricks.com/clusters/conf
 * `max_workers` - (Optional) The maximum number of workers to which the cluster can scale up when overloaded. max_workers must be strictly greater than min_workers.
 
 When using a [Single Node cluster](https://docs.databricks.com/clusters/single-node.html), `num_workers` needs to be `0`. It can be set to `0` explicitly, or simply not specified, as it defaults to `0`.  When `num_workers` is `0`, provider checks for presence of the required Spark configurations:
-* `spark.master` must has prefix `local`, like `local[*]`
+* `spark.master` must have prefix `local`, like `local[*]`
 * `spark.databricks.cluster.profile` must have value `singleNode`
 
 and also `custom_tag` entry:

docs/resources/external_location.md

@@ -56,8 +56,8 @@ resource "databricks_storage_credential" "external" {
 resource "databricks_external_location" "some" {
   name = "external"
   url = format("abfss://%s@%s.dfs.core.windows.net/",
-    azurerm_storage_account.ext_storage.name,
-  azurerm_storage_container.ext_storage.name)
+    azurerm_storage_container.ext_storage.name,
+  azurerm_storage_account.ext_storage.name)
   credential_name = databricks_storage_credential.external.id
   comment         = "Managed by TF"
   depends_on = [

docs/resources/grants.md

@@ -46,7 +46,7 @@ resource "databricks_grants" "sandbox" {
   grant {
     principal  = "Data Sharer"
     privileges = ["CREATE_RECIPIENT", "CREATE_SHARE"]
-  }  
+  }
 }
 ```
 
@@ -77,7 +77,7 @@ resource "databricks_grants" "sandbox" {
   grant {
     principal  = "Data Analyst"
     privileges = ["USE_CATALOG", "USE_SCHEMA", "SELECT"]
-  }  
+  }
 }
 ```
 
@@ -225,11 +225,11 @@ You can grant `SELECT` to [databricks_recipient](recipient.md) on [databricks_sh
 
 ```hcl
 resource "databricks_share" "some" {
-  name            = "my_share"
+  name = "my_share"
 }
 
 resource "databricks_recipient" "some" {
-  name            = "my_recipient"
+  name = "my_recipient"
 }
 
 resource "databricks_grants" "some" {

docs/resources/metastore.md

@@ -31,8 +31,8 @@ For Azure
 resource "databricks_metastore" "this" {
   name = "primary"
   storage_root = format("abfss://%s@%s.dfs.core.windows.net/",
-    azurerm_storage_account.unity_catalog.name,
-  azurerm_storage_container.unity_catalog.name)
+    azurerm_storage_container.unity_catalog.name,
+  azurerm_storage_account.unity_catalog.name)
   owner         = "uc admins"
   force_destroy = true
 }

docs/resources/metastore_data_access.md

@@ -33,8 +33,8 @@ For Azure using managed identity as credential (recommended)
 resource "databricks_metastore" "this" {
   name = "primary"
   storage_root = format("abfss://%s@%s.dfs.core.windows.net/",
-    azurerm_storage_account.unity_catalog.name,
-  azurerm_storage_container.unity_catalog.name)
+    azurerm_storage_container.unity_catalog.name,
+  azurerm_storage_account.unity_catalog.name)
   owner         = "uc admins"
   force_destroy = true
 }
@@ -55,8 +55,8 @@ For Azure using service principal as credential
 resource "databricks_metastore" "this" {
   name = "primary"
   storage_root = format("abfss://%s@%s.dfs.core.windows.net/",
-    azurerm_storage_account.unity_catalog.name,
-  azurerm_storage_container.unity_catalog.name)
+    azurerm_storage_container.unity_catalog.name,
+  azurerm_storage_account.unity_catalog.name)
   owner         = "uc admins"
   force_destroy = true
 }

docs/resources/mws_vpc_endpoint.md

@@ -15,23 +15,23 @@ Before using this resource, you will need to create the necessary VPC Endpoints
 
 ```hcl
 resource "aws_vpc_endpoint" "workspace" {
-  vpc_id             = module.vpc.vpc_id
-  service_name       = local.private_link.workspace_service
-  vpc_endpoint_type  = "Interface"
-  security_group_ids = [module.vpc.default_security_group_id]
-  subnet_ids         = [aws_subnet.pl_subnet.id]
-  depends_on         = [aws_subnet.pl_subnet]
-  private_dns_enabled = true  
+  vpc_id              = module.vpc.vpc_id
+  service_name        = local.private_link.workspace_service
+  vpc_endpoint_type   = "Interface"
+  security_group_ids  = [module.vpc.default_security_group_id]
+  subnet_ids          = [aws_subnet.pl_subnet.id]
+  depends_on          = [aws_subnet.pl_subnet]
+  private_dns_enabled = true
 }
 
 resource "aws_vpc_endpoint" "relay" {
-  vpc_id             = module.vpc.vpc_id
-  service_name       = local.private_link.relay_service
-  vpc_endpoint_type  = "Interface"
-  security_group_ids = [module.vpc.default_security_group_id]
-  subnet_ids         = [aws_subnet.pl_subnet.id]
-  depends_on         = [aws_subnet.pl_subnet]
-  private_dns_enabled = true  
+  vpc_id              = module.vpc.vpc_id
+  service_name        = local.private_link.relay_service
+  vpc_endpoint_type   = "Interface"
+  security_group_ids  = [module.vpc.default_security_group_id]
+  subnet_ids          = [aws_subnet.pl_subnet.id]
+  depends_on          = [aws_subnet.pl_subnet]
+  private_dns_enabled = true
 }
 ```