hashicorp · findkim · Oct 31, 2019 · Oct 31, 2019
diff --git a/.travis.yml b/.travis.yml
@@ -18,6 +18,7 @@ install:
 - make tools
 
 script:
+- make docscheck
 - make lint
 - make test
 - make website-test

diff --git a/GNUmakefile b/GNUmakefile
@@ -56,5 +56,8 @@ ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO)))
 endif
 	@$(MAKE) -C $(GOPATH)/src/$(WEBSITE_REPO) website-provider-test PROVIDER_PATH=$(shell pwd) PROVIDER_NAME=$(PKG_NAME)
 
-.PHONY: build test testacc vet fmt fmtcheck lint tools errcheck test-compile website website-test
+docscheck:
+	@sh -c "'$(CURDIR)/scripts/docscheck.sh'"
+
+.PHONY: build test testacc vet fmt fmtcheck lint tools errcheck test-compile website website-test docscheck
 
diff --git a/scripts/docscheck.sh b/scripts/docscheck.sh
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+docs=$(ls website/docs/**/*.markdown)
+error=false
+
+for doc in $docs; do
+  dirname=$(dirname "$doc")
+  category=$(basename "$dirname")
+
+  case "$category" in
+    "guides")
+      # Guides require a page_title
+      if ! grep "^page_title: " "$doc" > /dev/null; then
+        echo "Guide is missing a page_title: $doc"
+        error=true
+      fi
+      ;;
+
+    "d" | "r")
+      # Resources and data sources require a subcategory
+      if ! grep "^subcategory: " "$doc" > /dev/null; then
+        echo "Doc is missing a subcategory: $doc"
+        error=true
+      fi
+      ;;
+
+    *)
+      error=true
+      echo "Unknown category \"$category\". " \
+        "Docs can only exist in r/, d/, or guides/ folders."
+      ;;
+  esac
+done
+
+if $error; then
+  exit 1
+fi
+
+exit 0
diff --git a/website/docs/d/datasource_client_config.html.markdown b/website/docs/d/datasource_client_config.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_client_config"
 sidebar_current: "docs-google-datasource-client-config"

diff --git a/website/docs/d/datasource_cloudfunctions_function.html.markdown b/website/docs/d/datasource_cloudfunctions_function.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_cloudfunctions_function"
 sidebar_current: "docs-google-datasource-cloudfunctions-function"

diff --git a/website/docs/d/datasource_compute_address.html.markdown b/website/docs/d/datasource_compute_address.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_address"
 sidebar_current: "docs-google-datasource-compute-address"
@@ -55,4 +56,4 @@ exported:
 
 * `self_link` - The URI of the created resource.
 * `address` - The IP of the created resource.
-* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
+* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
diff --git a/website/docs/d/datasource_compute_forwarding_rule.html.markdown b/website/docs/d/datasource_compute_forwarding_rule.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_forwarding_rule"
 sidebar_current: "docs-google-datasource-compute-forwarding-rule"

diff --git a/website/docs/d/datasource_compute_global_address.html.markdown b/website/docs/d/datasource_compute_global_address.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_global_address"
 sidebar_current: "docs-google-datasource-compute-global-address"
@@ -52,4 +53,4 @@ exported:
 
 * `self_link` - The URI of the created resource.
 * `address` - The IP of the created resource.
-* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
+* `status` - Indicates if the address is used. Possible values are: RESERVED or IN_USE.
diff --git a/website/docs/d/datasource_compute_image.html.markdown b/website/docs/d/datasource_compute_image.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_image"
 sidebar_current: "docs-google-datasource-compute-image"

diff --git a/website/docs/d/datasource_compute_instance.html.markdown b/website/docs/d/datasource_compute_instance.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_instance"
 sidebar_current: "docs-google-datasource-compute-instance-x"

diff --git a/website/docs/d/datasource_compute_lb_ip_ranges.html.markdown b/website/docs/d/datasource_compute_lb_ip_ranges.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_lb_ip_ranges"
 sidebar_current: "docs-google-datasource-compute-lb-ip-ranges"

diff --git a/website/docs/d/datasource_compute_network.html.markdown b/website/docs/d/datasource_compute_network.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_network"
 sidebar_current: "docs-google-datasource-compute-network"

diff --git a/website/docs/d/datasource_compute_region_instance_group.html.markdown b/website/docs/d/datasource_compute_region_instance_group.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_region_instance_group"
 sidebar_current: "docs-google-datasource-compute-region-instance-group"

diff --git a/website/docs/d/datasource_compute_ssl_certificate.html.markdown b/website/docs/d/datasource_compute_ssl_certificate.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_ssl_certificate"
 sidebar_current: "docs-google-datasource-compute-ssl-certificate"

diff --git a/website/docs/d/datasource_compute_ssl_policy.html.markdown b/website/docs/d/datasource_compute_ssl_policy.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_ssl_policy"
 sidebar_current: "docs-google-datasource-compute-ssl-policy"
@@ -48,4 +49,4 @@ In addition to the arguments listed above, the following attributes are exported
 
 * `fingerprint` - Fingerprint of this resource.
 
-* `self_link` - The URI of the created resource.
+* `self_link` - The URI of the created resource.
diff --git a/website/docs/d/datasource_compute_subnetwork.html.markdown b/website/docs/d/datasource_compute_subnetwork.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_subnetwork"
 sidebar_current: "docs-google-datasource-compute-subnetwork"

diff --git a/website/docs/d/datasource_compute_vpn_gateway.html.markdown b/website/docs/d/datasource_compute_vpn_gateway.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_vpn_gateway"
 sidebar_current: "docs-google-datasource-compute-vpn-gateway"

diff --git a/website/docs/d/datasource_google_client_openid_userinfo.html.markdown b/website/docs/d/datasource_google_client_openid_userinfo.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_client_openid_userinfo"
 sidebar_current: "docs-google-datasource-client-openid-userinfo"

diff --git a/website/docs/d/datasource_google_composer_image_versions.html.markdown b/website/docs/d/datasource_google_composer_image_versions.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_composer_image_versions"
 sidebar_current: "docs-google-datasource-composer-image-versions"
@@ -43,4 +44,4 @@ The following attributes are exported:
 
 * `image_versions` - A list of composer image versions available in the given project and location. Each `image_version` contains:
   * `image_version_id` - The string identifier of the image version, in the form: "composer-x.y.z-airflow-a.b(.c)"
-  * `supported_python_versions` - Supported python versions for this image version
+  * `supported_python_versions` - Supported python versions for this image version
diff --git a/website/docs/d/datasource_google_compute_backend_service.html.markdown b/website/docs/d/datasource_google_compute_backend_service.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_backend_service"
 sidebar_current: "docs-google-datasource-compute-backend-service"

diff --git a/website/docs/d/datasource_google_compute_network_endpoint_group.html.markdown b/website/docs/d/datasource_google_compute_network_endpoint_group.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_network_endpoint_group"
 sidebar_current: "docs-google-datasource-compute-network-endpoint-group"

diff --git a/website/docs/d/datasource_google_folder_organization_policy.html.markdown b/website/docs/d/datasource_google_folder_organization_policy.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_folder_organization_policy"
 sidebar_current: "docs-google-datasource-folder-organization-policy"

diff --git a/website/docs/d/datasource_google_iam_role.html.markdown b/website/docs/d/datasource_google_iam_role.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_iam_role"
 sidebar_current: "docs-google-datasource-iam-role"

diff --git a/website/docs/d/datasource_google_netblock_ip_ranges.html.markdown b/website/docs/d/datasource_google_netblock_ip_ranges.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_netblock_ip_ranges"
 sidebar_current: "docs-google-datasource-netblock-ip-ranges"

diff --git a/website/docs/d/datasource_google_project_organization_policy.html.markdown b/website/docs/d/datasource_google_project_organization_policy.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_project_organization_policy"
 sidebar_current: "docs-google-datasource-project-organization-policy"

diff --git a/website/docs/d/datasource_google_service_account.html.markdown b/website/docs/d/datasource_google_service_account.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_service_account"
 sidebar_current: "docs-google-datasource-service-account"

diff --git a/website/docs/d/datasource_google_service_account_access_token.html.markdown b/website/docs/d/datasource_google_service_account_access_token.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_service_account_access_token"
 sidebar_current: "docs-google-service-account-access-token"

diff --git a/website/docs/d/datasource_google_service_account_key.html.markdown b/website/docs/d/datasource_google_service_account_key.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_service_account_key"
 sidebar_current: "docs-google-datasource-service-account-key"

diff --git a/website/docs/d/datasource_tpu_tensorflow_versions.html.markdown b/website/docs/d/datasource_tpu_tensorflow_versions.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_tpu_tensorflow_versions"
 sidebar_current: "docs-google-datasource-tpu-tensorflow-versions"

diff --git a/website/docs/d/dns_managed_zone.html.markdown b/website/docs/d/dns_managed_zone.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_dns_managed_zone"
 sidebar_current: "docs-google-datasource-dns-managed-zone"

diff --git a/website/docs/d/google_active_folder.html.markdown b/website/docs/d/google_active_folder.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_active_folder"
 sidebar_current: "docs-google-datasource-active-folder"

diff --git a/website/docs/d/google_billing_account.html.markdown b/website/docs/d/google_billing_account.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_billing_account"
 sidebar_current: "docs-google-datasource-billing-account"

diff --git a/website/docs/d/google_compute_default_service_account.html.markdown b/website/docs/d/google_compute_default_service_account.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_default_service_account"
 sidebar_current: "docs-google-datasource-compute-default-service-account"

diff --git a/website/docs/d/google_compute_instance_group.html.markdown b/website/docs/d/google_compute_instance_group.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_instance_group"
 sidebar_current: "docs-google-datasource-compute-instance-group"

diff --git a/website/docs/d/google_compute_node_types.html.markdown b/website/docs/d/google_compute_node_types.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_node_types"
 sidebar_current: "docs-google-datasource-compute-node-types"

diff --git a/website/docs/d/google_compute_regions.html.markdown b/website/docs/d/google_compute_regions.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_regions"
 sidebar_current: "docs-google-datasource-compute-regions"

diff --git a/website/docs/d/google_compute_zones.html.markdown b/website/docs/d/google_compute_zones.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_compute_zones"
 sidebar_current: "docs-google-datasource-compute-zones"

diff --git a/website/docs/d/google_container_cluster.html.markdown b/website/docs/d/google_container_cluster.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_container_cluster"
 sidebar_current: "docs-google-datasource-container-cluster"

diff --git a/website/docs/d/google_container_engine_versions.html.markdown b/website/docs/d/google_container_engine_versions.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_container_engine_versions"
 sidebar_current: "docs-google-datasource-container-versions"

diff --git a/website/docs/d/google_container_registry_image.html.markdown b/website/docs/d/google_container_registry_image.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_container_registry_image"
 sidebar_current: "docs-google-datasource-container-image"

diff --git a/website/docs/d/google_container_registry_repository.html.markdown b/website/docs/d/google_container_registry_repository.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_container_registry_repository"
 sidebar_current: "docs-google-datasource-container-repo"

diff --git a/website/docs/d/google_folder.html.markdown b/website/docs/d/google_folder.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_folder"
 sidebar_current: "docs-google-datasource-folder"

diff --git a/website/docs/d/google_iam_policy.html.markdown b/website/docs/d/google_iam_policy.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_iam_policy"
 sidebar_current: "docs-google-datasource-iam-policy"

diff --git a/website/docs/d/google_kms_crypto_key.html.markdown b/website/docs/d/google_kms_crypto_key.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_kms_crypto_key"
 sidebar_current: "docs-google-datasource-kms-crypto-key"

diff --git a/website/docs/d/google_kms_crypto_key_version.html.markdown b/website/docs/d/google_kms_crypto_key_version.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_kms_crypto_key_version"
 sidebar_current: "docs-google-datasource-kms-crypto-key-version"

diff --git a/website/docs/d/google_kms_key_ring.html.markdown b/website/docs/d/google_kms_key_ring.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_kms_key_ring"
 sidebar_current: "docs-google-datasource-kms-key-ring"

diff --git a/website/docs/d/google_kms_secret.html.markdown b/website/docs/d/google_kms_secret.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_kms_secret"
 sidebar_current: "docs-google-kms-secret"

diff --git a/website/docs/d/google_kms_secret_ciphertext.html.markdown b/website/docs/d/google_kms_secret_ciphertext.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_kms_secret_ciphertext"
 sidebar_current: "docs-google-kms-secret-ciphertext"

diff --git a/website/docs/d/google_organization.html.markdown b/website/docs/d/google_organization.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_organization"
 sidebar_current: "docs-google-datasource-organization"

diff --git a/website/docs/d/google_project.html.markdown b/website/docs/d/google_project.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_project"
 sidebar_current: "docs-google-datasource-project"

diff --git a/website/docs/d/google_project_services.html.markdown b/website/docs/d/google_project_services.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_project_services"
 sidebar_current: "docs-google-datasource-project-services"

diff --git a/website/docs/d/google_projects.html.markdown b/website/docs/d/google_projects.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_projects"
 sidebar_current: "docs-google-datasource-projects"

diff --git a/website/docs/d/google_storage_project_service_account.html.markdown b/website/docs/d/google_storage_project_service_account.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_storage_project_service_account"
 sidebar_current: "docs-google-datasource-storage-project-service-account"

diff --git a/website/docs/d/google_storage_transfer_project_service_account.html.markdown b/website/docs/d/google_storage_transfer_project_service_account.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_storage_transfer_project_service_account"
 sidebar_current: "docs-google-datasource-storage-transfer-project-service-account"

diff --git a/website/docs/d/signed_url.html.markdown b/website/docs/d/signed_url.html.markdown
@@ -1,4 +1,5 @@
 ---
+subcategory: "Google Cloud Platform"
 layout: "google"
 page_title: "Google: google_storage_object_signed_url"
 sidebar_current: "docs-google-datasource-signed_url"