Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Consul Docs #614

Merged
merged 1 commit into from
Oct 3, 2023
Merged

Fix Consul Docs #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data-sources/consul_agent_helm_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -17,7 +18,6 @@ data "hcp_consul_agent_helm_config" "example" {
}
```


<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/consul_agent_kubernetes_secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -41,4 +42,3 @@ If a project is not configured in the HCP Provider config block, the oldest proj
Optional:

- `default` (String)

2 changes: 1 addition & 1 deletion docs/data-sources/consul_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -72,4 +73,3 @@ Read-Only:

- `address` (String)
- `description` (String)

2 changes: 1 addition & 1 deletion docs/data-sources/consul_versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -34,4 +35,3 @@ data "hcp_consul_versions" "default" {}
Optional:

- `default` (String)

2 changes: 1 addition & 1 deletion docs/guides/consul-federation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consul-root-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/snapshots.md → docs/guides/consul-snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/resources/consul_snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion templates/data-sources/consul_agent_helm_config.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "HCP Consul"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

Expand All @@ -12,5 +13,4 @@ description: |-

{{ tffile "examples/data-sources/hcp_consul_agent_helm_config/data-source.tf" }}


{{ .SchemaMarkdown | trimspace }}
2 changes: 1 addition & 1 deletion templates/data-sources/consul_agent_kubernetes_secret.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "HCP Consul"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

Expand All @@ -13,4 +14,3 @@ description: |-
{{ tffile "examples/data-sources/hcp_consul_agent_kubernetes_secret/data-source.tf" }}

{{ .SchemaMarkdown | trimspace }}

2 changes: 1 addition & 1 deletion templates/data-sources/consul_cluster.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "HCP Consul"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

Expand All @@ -13,4 +14,3 @@ description: |-
{{ tffile "examples/data-sources/hcp_consul_cluster/data-source.tf" }}

{{ .SchemaMarkdown | trimspace }}

2 changes: 1 addition & 1 deletion templates/data-sources/consul_versions.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "HCP Consul"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

Expand All @@ -13,4 +14,3 @@ description: |-
{{ tffile "examples/data-sources/hcp_consul_versions/data-source.tf" }}

{{ .SchemaMarkdown | trimspace }}

2 changes: 1 addition & 1 deletion templates/guides/consul-federation.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion templates/guides/consul-root-token.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion templates/guides/snapshots.md.tmpl → templates/guides/consul-snapshots.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions templates/resources/consul_snapshot.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: "HCP Consul"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

Expand Down