Fix Vault Docs (#617)

hashicorp · Sep 28, 2023 · 7b32fc3 · 7b32fc3
1 parent 3811ce9
commit 7b32fc3
Show file tree

Hide file tree

Showing 12 changed files with 34 additions and 16 deletions.
diff --git a/docs/data-sources/vault_cluster.md b/docs/data-sources/vault_cluster.md
@@ -3,6 +3,7 @@ page_title: "hcp_vault_cluster Data Source - terraform-provider-hcp"
 subcategory: "HCP Vault"
 description: |-
   The cluster data source provides information about an existing HCP Vault cluster.
+---
 
 # hcp_vault_cluster (Data Source)
 
@@ -110,4 +111,3 @@ Read-Only:
 - `grafana_endpoint` (String) Grafana endpoint for streaming metrics
 - `grafana_user` (String) Grafana user for streaming metrics
 - `splunk_hecendpoint` (String) Splunk endpoint for streaming metrics
-
diff --git a/docs/data-sources/vault_plugin.md b/docs/data-sources/vault_plugin.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hcp_vault_plugin Data Source - terraform-provider-hcp"
-subcategory: ""
+subcategory: "HCP Vault"
 description: |-
   The Vault plugin data source provides information about an existing HCP Vault plugin
 ---
@@ -10,8 +9,6 @@ description: |-
 
 The Vault plugin data source provides information about an existing HCP Vault plugin
 
-
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/docs/guides/vault-admin-token.md b/docs/guides/vault-admin-token.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Create a Vault cluster and admin token - HCP Provider"
 description: |-
     An example of creating a Vault cluster and admin token.

diff --git a/docs/guides/vault-performance-replication.md b/docs/guides/vault-performance-replication.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Configure Vault performance replication - HCP Provider"
 description: |-
     Configure performance replication between two Plus tier clusters.

diff --git a/docs/guides/vault-scaling.md b/docs/guides/vault-scaling.md
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Resize or scale a Vault cluster - HCP Provider"
 description: |-
     Change a current HCP Vault cluster in terms of tiers (Dev, Starter, Standard, Plus) or sizes (S, M, L).

diff --git a/docs/resources/vault_plugin.md b/docs/resources/vault_plugin.md
@@ -1,7 +1,6 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "hcp_vault_plugin Resource - terraform-provider-hcp"
-subcategory: ""
+subcategory: "HCP Vault"
 description: |-
   The Vault plugin resource allows you to manage an HCP Vault plugin.
 ---
@@ -10,8 +9,6 @@ description: |-
 
 The Vault plugin resource allows you to manage an HCP Vault plugin.
 
-
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/templates/data-sources/vault_cluster.md.tmpl b/templates/data-sources/vault_cluster.md.tmpl
@@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
 subcategory: "HCP Vault"
 description: |-
 {{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
 
 # {{.Name}} ({{.Type}})
 
@@ -13,4 +14,3 @@ description: |-
 {{ tffile "examples/data-sources/hcp_vault_cluster/data-source.tf" }}
 
 {{ .SchemaMarkdown | trimspace }}
-
diff --git a/templates/data-sources/vault_plugin.md.tmpl b/templates/data-sources/vault_plugin.md.tmpl
@@ -0,0 +1,12 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: "HCP Vault"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+{{ .SchemaMarkdown | trimspace }}
diff --git a/templates/guides/vault-admin-token.md.tmpl b/templates/guides/vault-admin-token.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Create a Vault cluster and admin token - HCP Provider"
 description: |-
     An example of creating a Vault cluster and admin token.

diff --git a/templates/guides/vault-performance-replication.md.tmpl b/templates/guides/vault-performance-replication.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Configure Vault performance replication - HCP Provider"
 description: |-
     Configure performance replication between two Plus tier clusters.

diff --git a/templates/guides/vault-scaling.md.tmpl b/templates/guides/vault-scaling.md.tmpl
@@ -1,5 +1,5 @@
 ---
-subcategory: ""
+subcategory: "HCP Vault"
 page_title: "Resize or scale a Vault cluster - HCP Provider"
 description: |-
     Change a current HCP Vault cluster in terms of tiers (Dev, Starter, Standard, Plus) or sizes (S, M, L).

diff --git a/templates/resources/vault_plugin.md.tmpl b/templates/resources/vault_plugin.md.tmpl
@@ -0,0 +1,12 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: "HCP Vault"
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+{{ .SchemaMarkdown | trimspace }}