Add override for docs sections - apply to compute and monitoring. (#5257

) * Add override for docs sections - apply to compute and monitoring. * These compute resources are actually handwritten, and the monitoring has no GA.
GoogleCloudPlatform · Sep 30, 2021 · 40aed39 · 40aed39
1 parent 20ac3d1
commit 40aed39
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 6 deletions.
diff --git a/mmv1/third_party/terraform/website/docs/r/compute_firewall_policy.html.markdown b/mmv1/third_party/terraform/website/docs/r/compute_firewall_policy.html.markdown
@@ -13,7 +13,7 @@
 #     are required, please file an issue at https:#github.com/hashicorp/terraform-provider-google/issues/new/choose
 #
 # ----------------------------------------------------------------------------
-subcategory: "Compute"
+subcategory: "Compute Engine"
 layout: "google"
 page_title: "Google: google_compute_firewall_policy"
 sidebar_current: "docs-google-compute-firewall-policy"

diff --git a/...arty/terraform/website/docs/r/compute_firewall_policy_association.html.markdown b/...arty/terraform/website/docs/r/compute_firewall_policy_association.html.markdown
@@ -13,7 +13,7 @@
 #     are required, please file an issue at https:#github.com/hashicorp/terraform-provider-google/issues/new/choose
 #
 # ----------------------------------------------------------------------------
-subcategory: "Compute"
+subcategory: "Compute Engine"
 layout: "google"
 page_title: "Google: google_compute_firewall_policy_association"
 sidebar_current: "docs-google-compute-firewall-policy-association"

diff --git a/...third_party/terraform/website/docs/r/compute_firewall_policy_rule.html.markdown b/...third_party/terraform/website/docs/r/compute_firewall_policy_rule.html.markdown
@@ -13,7 +13,7 @@
 #     are required, please file an issue at https:#github.com/hashicorp/terraform-provider-google/issues/new/choose
 #
 # ----------------------------------------------------------------------------
-subcategory: "Compute"
+subcategory: "Compute Engine"
 layout: "google"
 page_title: "Google: google_compute_firewall_policy_rule"
 sidebar_current: "docs-google-compute-firewall-policy-rule"

diff --git a/tpgtools/override.go b/tpgtools/override.go
@@ -27,8 +27,9 @@ type OverrideType string // enum
 
 // Product-level Overrides
 const (
-	ProductBasePath OverrideType = "PRODUCT_BASE_PATH"
-	ProductTitle    OverrideType = "PRODUCT_TITLE"
+	ProductBasePath    OverrideType = "PRODUCT_BASE_PATH"
+	ProductTitle       OverrideType = "PRODUCT_TITLE"
+	ProductDocsSection OverrideType = "PRODUCT_DOCS_SECTION"
 )
 
 // Resource-level Overrides

diff --git a/tpgtools/override_details.go b/tpgtools/override_details.go
@@ -206,3 +206,8 @@ type ProductTitleDetails struct {
 	// alternative name to be used for the product resources
 	Title string
 }
+
+type ProductDocsSectionDetails struct {
+	// alternative name to be used for the product resources in docs.
+	DocsSection string
+}
diff --git a/tpgtools/overrides/compute/beta/tpgtools_product.yaml b/tpgtools/overrides/compute/beta/tpgtools_product.yaml
@@ -0,0 +1,5 @@
+## product level overrides
+
+- type: PRODUCT_DOCS_SECTION
+  details:
+    docssection: Compute Engine
diff --git a/tpgtools/overrides/compute/tpgtools_product.yaml b/tpgtools/overrides/compute/tpgtools_product.yaml
@@ -0,0 +1,5 @@
+## product level overrides
+
+- type: PRODUCT_DOCS_SECTION
+  details:
+    docssection: Compute Engine
diff --git a/tpgtools/overrides/monitoring/beta/tpgtools_product.yaml b/tpgtools/overrides/monitoring/beta/tpgtools_product.yaml
@@ -0,0 +1,5 @@
+## product level overrides
+
+- type: PRODUCT_DOCS_SECTION
+  details:
+    docssection: Cloud (Stackdriver) Monitoring
diff --git a/tpgtools/product.go b/tpgtools/product.go
@@ -128,6 +128,23 @@ func (pm *ProductMetadata) ProductType() string {
 	return snakeToTitleCase(pm.ProductName)
 }
 
+func (pm *ProductMetadata) DocsSection() string {
+	overrides, ok := productOverrides[pm.PackagePath]
+	if !ok {
+		glog.Fatalf("product overrides should be loaded already for packagePath %s", pm.PackagePath)
+	}
+	pt := ProductDocsSectionDetails{}
+	ptOk, err := overrides.ProductOverrideWithDetails(ProductDocsSection, &pt)
+	if err != nil {
+		glog.Fatalf("could not parse override %v", err)
+	}
+	if ptOk {
+		return pt.DocsSection
+	}
+
+	return pm.ProductType()
+}
+
 // ProductNameUpper is the all caps snakecase product name of a resource.
 // For example, "NETWORK_SERVICES".
 func (pm *ProductMetadata) ProductNameUpper() string {

diff --git a/tpgtools/resource.go b/tpgtools/resource.go
@@ -209,6 +209,12 @@ func (r Resource) ProductType() string {
 	return r.productMetadata.ProductType()
 }
 
+// DocsSection is *usuallu* the title-cased product name of a resource. For example,
+// "NetworkServices" - but subject to overrides.
+func (r Resource) DocsSection() string {
+	return r.productMetadata.DocsSection()
+}
+
 // ProductType is the snakecase product name of a resource. For example,
 // "network_services".
 func (r Resource) ProductName() string {

diff --git a/tpgtools/templates/resource.html.markdown.tmpl b/tpgtools/templates/resource.html.markdown.tmpl
@@ -26,7 +26,7 @@
 #     are required, please file an issue at https:#github.com/hashicorp/terraform-provider-google/issues/new/choose
 #
 # ----------------------------------------------------------------------------
-subcategory: "{{$.ProductType}}"
+subcategory: "{{$.DocsSection}}"
 layout: "google"
 page_title: "Google: {{$.TerraformName}}"
 sidebar_current: "{{$.SidebarCurrent}}"