Fix Consul Docs (#614)

hashicorp · Oct 3, 2023 · ddb0285 · ddb0285
1 parent 6c01ab0
commit ddb0285
Show file tree

Hide file tree

Showing 16 changed files with 16 additions and 14 deletions.
diff --git a/docs/data-sources/consul_agent_helm_config.md b/docs/data-sources/consul_agent_helm_config.md
@@ -3,6 +3,7 @@ page_title: "hcp_consul_agent_helm_config Data Source - terraform-provider-hcp"
 subcategory: "HCP Consul"
 description: |-
   The Consul agent Helm config data source provides Helm values for a Consul agent running in Kubernetes.
+---
 
 # hcp_consul_agent_helm_config (Data Source)
 
@@ -17,7 +18,6 @@ data "hcp_consul_agent_helm_config" "example" {
 }
 ```
 
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/docs/data-sources/consul_agent_kubernetes_secret.md b/docs/data-sources/consul_agent_kubernetes_secret.md
@@ -3,6 +3,7 @@ page_title: "hcp_consul_agent_kubernetes_secret Data Source - terraform-provider
 subcategory: "HCP Consul"
 description: |-
   The agent config Kubernetes secret data source provides Consul agents running in Kubernetes the configuration needed to connect to the Consul cluster.
+---
 
 # hcp_consul_agent_kubernetes_secret (Data Source)
 
@@ -41,4 +42,3 @@ If a project is not configured in the HCP Provider config block, the oldest proj
 Optional:
 
 - `default` (String)
-
diff --git a/docs/data-sources/consul_cluster.md b/docs/data-sources/consul_cluster.md
@@ -3,6 +3,7 @@ page_title: "hcp_consul_cluster Data Source - terraform-provider-hcp"
 subcategory: "HCP Consul"
 description: |-
   The cluster data source provides information about an existing HCP Consul cluster.
+---
 
 # hcp_consul_cluster (Data Source)
 
@@ -72,4 +73,3 @@ Read-Only:
 
 - `address` (String)
 - `description` (String)
-
diff --git a/docs/data-sources/consul_versions.md b/docs/data-sources/consul_versions.md
@@ -3,6 +3,7 @@ page_title: "hcp_consul_versions Data Source - terraform-provider-hcp"
 subcategory: "HCP Consul"
 description: |-
   The Consul versions data source provides the Consul versions supported by HCP.
+---
 
 # hcp_consul_versions (Data Source)
 
@@ -34,4 +35,3 @@ data "hcp_consul_versions" "default" {}
 Optional:
 
 - `default` (String)
-
diff --git a/docs/guides/consul-federation.md b/docs/guides/consul-federation.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Consul Federation with Auto HVN Peering - HCP Provider"
 description: |-
     An example of federating a new HCP Consul cluster with an existing one via auto peering.

diff --git a/docs/guides/consul-root-token.md b/docs/guides/consul-root-token.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Create a new ACL root token - HCP Provider"
 description: |-
     An example of creating a new ACL root token.

diff --git a/docs/guides/snapshots.md → docs/guides/consul-snapshots.md b/docs/guides/snapshots.md → docs/guides/consul-snapshots.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Create Consul cluster snapshots in HCP - HCP Provider"
 description: |-
     An example of creating an HCP Consul cluster snapshot.

diff --git a/docs/resources/consul_snapshot.md b/docs/resources/consul_snapshot.md
@@ -3,6 +3,7 @@ page_title: "hcp_consul_snapshot Resource - terraform-provider-hcp"
 subcategory: "HCP Consul"
 description: |-
   The Consul snapshot resource allows users to manage Consul snapshots of an HCP Consul cluster. Snapshots currently have a retention policy of 30 days.
+---
 
 # hcp_consul_snapshot (Resource)
 

diff --git a/templates/data-sources/consul_agent_helm_config.md.tmpl b/templates/data-sources/consul_agent_helm_config.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Consul"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})
 
@@ -12,5 +13,4 @@ description: |-
 
 {{ tffile "examples/data-sources/hcp_consul_agent_helm_config/data-source.tf" }}
 
-
 {{ .SchemaMarkdown | trimspace }}
diff --git a/templates/data-sources/consul_agent_kubernetes_secret.md.tmpl b/templates/data-sources/consul_agent_kubernetes_secret.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Consul"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})
 
@@ -13,4 +14,3 @@ description: |-
 {{ tffile "examples/data-sources/hcp_consul_agent_kubernetes_secret/data-source.tf" }}
 
 {{ .SchemaMarkdown | trimspace }}
-
diff --git a/templates/data-sources/consul_cluster.md.tmpl b/templates/data-sources/consul_cluster.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Consul"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})
 
@@ -13,4 +14,3 @@ description: |-
 {{ tffile "examples/data-sources/hcp_consul_cluster/data-source.tf" }}
 
 {{ .SchemaMarkdown | trimspace }}
-
diff --git a/templates/data-sources/consul_versions.md.tmpl b/templates/data-sources/consul_versions.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Consul"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})
 
@@ -13,4 +14,3 @@ description: |-
 {{ tffile "examples/data-sources/hcp_consul_versions/data-source.tf" }}
 
 {{ .SchemaMarkdown | trimspace }}
-
diff --git a/templates/guides/consul-federation.md.tmpl b/templates/guides/consul-federation.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Consul Federation with Auto HVN Peering - HCP Provider"
 description: |-
     An example of federating a new HCP Consul cluster with an existing one via auto peering.

diff --git a/templates/guides/consul-root-token.md.tmpl b/templates/guides/consul-root-token.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Create a new ACL root token - HCP Provider"
 description: |-
     An example of creating a new ACL root token.

diff --git a/templates/guides/snapshots.md.tmpl → templates/guides/consul-snapshots.md.tmpl b/templates/guides/snapshots.md.tmpl → templates/guides/consul-snapshots.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Consul"
 page_title: "Create Consul cluster snapshots in HCP - HCP Provider"
 description: |-
     An example of creating an HCP Consul cluster snapshot.

diff --git a/templates/resources/consul_snapshot.md.tmpl b/templates/resources/consul_snapshot.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Consul"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})