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

Fix HVN Docs #615

Merged
merged 1 commit into from
Oct 2, 2023
Merged

Fix HVN Docs #615

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
1 change: 1 addition & 0 deletions docs/data-sources/hvn.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_hvn Data Source - terraform-provider-hcp"
subcategory: "HashiCorp Virtual Networks"
description: |-
The HVN data source provides information about an existing HashiCorp Virtual Network.
---

# hcp_hvn (Data Source)

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/hvn_peering_connection.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_hvn_peering_connection Data Source - terraform-provider-hcp"
subcategory: "HashiCorp Virtual Networks"
description: |-
The HVN peering connection data source provides information about an existing peering connection between HVNs.
---

# hcp_hvn_peering_connection (Data Source)

Expand Down Expand Up @@ -46,4 +47,3 @@ data "hcp_hvn_peering_connection" "test" {
Optional:

- `default` (String)

2 changes: 1 addition & 1 deletion docs/data-sources/hvn_route.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_hvn_route Data Source - terraform-provider-hcp"
subcategory: "HashiCorp Virtual Networks"
description: |-
The HVN route data source provides information about an existing HVN route.
---

# hcp_hvn_route (Data Source)

Expand Down Expand Up @@ -45,4 +46,3 @@ data "hcp_hvn_route" "example" {
Optional:

- `default` (String)

2 changes: 1 addition & 1 deletion docs/guides/hvn-route-migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
subcategory: ""
subcategory: "HashiCorp Virtual Networks"
page_title: "HVN Route Migration Guide - HCP Provider"
description: |-
An guide to migrating HCP networking resources to use HVN routes.
Expand Down
1 change: 1 addition & 0 deletions docs/resources/aws_network_peering.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_aws_network_peering Resource - terraform-provider-hcp"
subcategory: "HashiCorp Virtual Networks"
description: |-
The AWS network peering resource allows you to manage a network peering between an HVN and a peer AWS VPC.
---

# hcp_aws_network_peering (Resource)

Expand Down
1 change: 1 addition & 0 deletions docs/resources/hvn_peering_connection.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_hvn_peering_connection Resource - terraform-provider-hcp"
subcategory: "HashiCorp Virtual Networks"
description: |-
The HVN peering connection resource allows you to manage a peering connection between HVNs.
---

# hcp_hvn_peering_connection (Resource)

Expand Down
1 change: 1 addition & 0 deletions templates/data-sources/hvn.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: "HashiCorp Virtual Networks"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

Expand Down
2 changes: 1 addition & 1 deletion templates/data-sources/hvn_peering_connection.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: "HashiCorp Virtual Networks"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

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

{{ .SchemaMarkdown | trimspace }}

2 changes: 1 addition & 1 deletion templates/data-sources/hvn_route.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: "HashiCorp Virtual Networks"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

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

{{ .SchemaMarkdown | trimspace }}

2 changes: 1 addition & 1 deletion templates/guides/hvn-route-migration-guide.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
subcategory: ""
subcategory: "HashiCorp Virtual Networks"
page_title: "HVN Route Migration Guide - HCP Provider"
description: |-
An guide to migrating HCP networking resources to use HVN routes.
Expand Down
10 changes: 2 additions & 8 deletions templates/resources/aws_network_peering.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: "HashiCorp Virtual Networks"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

Expand All @@ -18,11 +19,4 @@ description: |-

Import is supported using the following syntax:

```shell
# Using an explicit project ID, the import ID is:
# {project_id}:{hvn_id}:{peering_id}
terraform import hcp_aws_network_peering.peer f709ec73-55d4-46d8-897d-816ebba28778:main-hvn:11eb60b3-d4ec-5eed-aacc-0242ac120015
# Using the provider-default project ID, the import ID is:
# {hvn_id}:{peering_id}
terraform import hcp_aws_network_peering.peer main-hvn:11eb60b3-d4ec-5eed-aacc-0242ac120015
```
{{ codefile "shell" "examples/resources/hcp_aws_network_peering/import.sh" }}
12 changes: 2 additions & 10 deletions templates/resources/hvn_peering_connection.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: "HashiCorp Virtual Networks"
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

Expand All @@ -18,13 +19,4 @@ description: |-

Import is supported using the following syntax:

```shell
# Only the first HVN ID is required (hvn_1_id), HVN 2 will be populated after import.

# Using an explicit project ID, the import ID is:
# {project_id}:{hvn_1_id}:{peering_id}
terraform import hcp_hvn_peering_connection.peer_1 f709ec73-55d4-46d8-897d-816ebba28778:hvn-1:peer-1
# Using the provider-default project ID, the import ID is:
# {hvn_1_id}:{peering_id}
terraform import hcp_hvn_peering_connection.peer_1 hvn-1:peer-1
```
{{ codefile "shell" "examples/resources/hcp_hvn_peering_connection/import.sh" }}