Skip to content

Commit 6c3adc4

Browse files
tenthirtyamtenthirtyam
committed
docs: migrate from legacy path
- Moves the documentation to `./docs` from the legacy `./website/docs` location. - Addressed markdown linting issues. - Addressed spelling errors. Reference: https://developer.hashicorp.com/terraform/registry/providers/docs#migrating-legacy-providers-docs Signed-off-by: Ryan Johnson <[email protected]>
1 parent 40b4937 commit 6c3adc4

File tree

305 files changed

+1365
-1705
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

305 files changed

+1365
-1705
lines changed

Diff for: ‎GNUmakefile

+7-7
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,23 @@ test-compile:
5858

5959
website-lint:
6060
@echo "==> Checking website against linters..."
61-
@misspell -error -source=text website/ || (echo; \
62-
echo "Unexpected mispelling found in website files."; \
61+
@misspell -error -source=text docs/ || (echo; \
62+
echo "Unexpected misspelling found in website files."; \
6363
echo "To automatically fix the misspelling, run 'make website-lint-fix' and commit the changes."; \
6464
exit 1)
65-
@terrafmt diff ./website --check --pattern '*.markdown' --quiet || (echo; \
65+
@terrafmt diff ./docs --check --pattern '*.md' --quiet || (echo; \
6666
echo "Unexpected differences in website HCL formatting."; \
67-
echo "To see the full differences, run: terrafmt diff ./website --pattern '*.markdown'"; \
67+
echo "To see the full differences, run: terrafmt diff ./docs --pattern '*.md'"; \
6868
echo "To automatically fix the formatting, run 'make website-lint-fix' and commit the changes."; \
6969
exit 1)
7070

7171
website-lint-fix:
7272
@echo "==> Applying automatic website linter fixes..."
73-
@misspell -w -source=text website/
74-
@terrafmt fmt ./website --pattern '*.markdown'
73+
@misspell -w -source=text docs/
74+
@terrafmt fmt ./docs --pattern '*.md'
7575

7676
website-list-category:
77-
@find . -name *.markdown | xargs grep subcategory | awk -F '"' '{print $$2}' | sort | uniq
77+
@find . -name *.md | xargs grep subcategory | awk -F '"' '{print $$2}' | sort | uniq
7878

7979
.PHONY: build test testacc vet fmt fmtcheck errcheck test-compile website-lint website-lint-fix tools
8080

Diff for: ‎website/docs/d/certificate.html.markdown renamed to ‎docs/data-sources/certificate.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: certificate"
54
description: A certificate data source.
65
---

Diff for: ‎website/docs/d/compute_collection.html.markdown renamed to ‎docs/data-sources/compute_collection.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: compute_collection"
54
description: A Compute Collection data source.
65
---

Diff for: ‎website/docs/d/compute_manager.html.markdown renamed to ‎docs/data-sources/compute_manager.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: compute_manager"
54
description: A Compute Manager data source.
65
---

Diff for: ‎website/docs/d/compute_manager_realization.html.markdown renamed to ‎docs/data-sources/compute_manager_realization.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Realization"
3-
layout: "nsxt"
43
page_title: "NSXT: compute_manager_realization"
54
description: Compute manager resource realization information.
65
---

Diff for: ‎website/docs/d/discovered_node.html.markdown renamed to ‎docs/data-sources/discovered_node.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: discovered_node"
54
description: An Discovered Node data source.
65
---
@@ -20,7 +19,6 @@ data "nsxt_discovered_node" "test" {
2019
## Example Usage when deploying together with Compute Manager
2120

2221
```hcl
23-
2422
resource "nsxt_compute_manager" "vc1" {
2523
display_name = "test-vcenter"
2624

Diff for: ‎website/docs/d/edge_cluster.html.markdown renamed to ‎docs/data-sources/edge_cluster.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: edge_cluster"
54
description: An Edge Cluster data source.
65
---

Diff for: ‎website/docs/d/edge_upgrade_group.html.markdown renamed to ‎docs/data-sources/edge_upgrade_group.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Beta"
3-
layout: "nsxt"
43
page_title: "NSXT: edge_upgrade_group"
54
description: An Edge Upgrade Group data source.
65
---

Diff for: ‎website/docs/d/failure_domain.html.markdown renamed to ‎docs/data-sources/failure_domain.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: failure_domain"
54
description: Failure Domain data source.
65
---

Diff for: ‎website/docs/d/firewall_section.html.markdown renamed to ‎docs/data-sources/firewall_section.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: firewall_section"
54
description: A firewall section data source.
65
---

Diff for: ‎website/docs/d/host_upgrade_group.html.markdown renamed to ‎docs/data-sources/host_upgrade_group.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Beta"
3-
layout: "nsxt"
43
page_title: "NSXT: host_upgrade_group"
54
description: A Host Upgrade Group data source.
65
---

Diff for: ‎website/docs/d/ip_pool.html.markdown renamed to ‎docs/data-sources/ip_pool.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: ip_pool"
54
description: A IP pool data source.
65
---

Diff for: ‎website/docs/d/logical_tier0_router.html.markdown renamed to ‎docs/data-sources/logical_tier0_router.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: logical_tier0_router"
54
description: A logical Tier 0 router data source.
65
---

Diff for: ‎website/docs/d/logical_tier1_router.html.markdown renamed to ‎docs/data-sources/logical_tier1_router.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: logical_tier1_router"
54
description: A logical Tier 1 router data source.
65
---

Diff for: ‎website/docs/d/mac_pool.html.markdown renamed to ‎docs/data-sources/mac_pool.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: mac_pool"
54
description: A MAC pool data source.
65
---

Diff for: ‎website/docs/d/management_cluster.html.markdown renamed to ‎docs/data-sources/management_cluster.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Manager"
3-
layout: "nsxt"
43
page_title: "NSXT: management_cluster"
54
description: A NSX-T management cluster data source.
65
---

Diff for: ‎docs/data-sources/manager_info.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
subcategory: "Manager"
3+
page_title: "nsxt_manager_info"
4+
description: A NSX manager information data source.
5+
---
6+
7+
# nsxt_manager_info
8+
9+
This data source provides various information about the NSX manager.
10+
11+
## Example Usage
12+
13+
```hcl
14+
data "nsxt_manager_info" "cluster" {}
15+
```
16+
17+
## Attributes Reference
18+
19+
* `version` - The software version of the NSX manager node.

Diff for: ‎website/docs/d/ns_group.html.markdown renamed to ‎docs/data-sources/ns_group.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: ns_group"
54
description: A networking and security group data source.
65
---

Diff for: ‎website/docs/d/ns_groups.html.markdown renamed to ‎docs/data-sources/ns_groups.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: ns_groups"
54
description: A networking and security groups data source. This data source builds "display name to id" map representation of the whole table.
65
---
76

87
# nsxt_ns_groups
98

10-
This data source builds a "name to uuid" map of the whole NS Group table. Such map can be referenced in configuration to obtain object uuids by display name at a cost of single roudtrip to NSX, which improves apply and refresh
9+
This data source builds a "name to uuid" map of the whole NS Group table. Such map can be referenced in configuration to obtain object uuids by display name at a cost of single roundtrip to NSX, which improves apply and refresh
1110
time at scale, compared to multiple instances of `nsxt_ns_group` data source.
1211

1312
## Example Usage

Diff for: ‎website/docs/d/ns_service.html.markdown renamed to ‎docs/data-sources/ns_service.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: ns_service"
54
description: A networking and security service data source.
65
---

Diff for: ‎website/docs/d/ns_services.html.markdown renamed to ‎docs/data-sources/ns_services.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Deprecated"
3-
layout: "nsxt"
43
page_title: "NSXT: ns_services"
54
description: A networking and security services data source. This data source builds "display name to id" map representation of the whole table.
65
---

Diff for: ‎website/docs/d/policy_bfd_profile.html.markdown renamed to ‎docs/data-sources/policy_bfd_profile.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Gateways and Routing"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_bfd_profile"
54
description: Policy BFD Profile data source.
65
---

Diff for: ‎website/docs/d/policy_bridge_profile.html.markdown renamed to ‎docs/data-sources/policy_bridge_profile.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Segments"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_bridge_profile"
54
description: Policy Bridge Profile data source.
65
---

Diff for: ‎website/docs/d/policy_certificate.html.markdown renamed to ‎docs/data-sources/policy_certificate.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Certificates"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_certificate"
54
description: Policy Certificate data source.
65
---

Diff for: ‎website/docs/d/policy_context_profile.html.markdown renamed to ‎docs/data-sources/policy_context_profile.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Firewall"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_context_profile"
54
description: Policy Context Profile Profile data source.
65
---
@@ -39,7 +38,7 @@ data "nsxt_policy_context_profile" "demoprof" {
3938
* `id` - (Optional) The ID of Profile to retrieve.
4039
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
4140
* `context` - (Optional) The context which the object belongs to
42-
* `project_id` - (Required) The ID of the project which the object belongs to
41+
* `project_id` - (Required) The ID of the project which the object belongs to
4342

4443
## Attributes Reference
4544

Diff for: ‎website/docs/d/policy_dhcp_server.html.markdown renamed to ‎docs/data-sources/policy_dhcp_server.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "DHCP"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_dhcp_server"
54
description: A policy DHCP server data source.
65
---
@@ -39,7 +38,7 @@ data "nsxt_policy_dhcp_server" "demodhcp" {
3938
* `id` - (Optional) The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
4039
* `display_name` - (Optional) The Display Name prefix of DHCP server to retrieve.
4140
* `context` - (Optional) The context which the object belongs to
42-
* `project_id` - (Required) The ID of the project which the object belongs to
41+
* `project_id` - (Required) The ID of the project which the object belongs to
4342

4443
## Attributes Reference
4544

Diff for: ‎website/docs/d/policy_distributed_flood_protection_profile.html.markdown renamed to ‎docs/data-sources/policy_distributed_flood_protection_profile.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Beta"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_distributed_flood_protection_profile"
54
description: Policy Distributed Flood Protection Profile data source.
65
---
@@ -38,7 +37,7 @@ resource "nsxt_policy_distributed_flood_protection_profile" "test" {
3837
* `id` - (Optional) The ID of Distributed Flood Protection Profile to retrieve.
3938
* `display_name` - (Optional) The Display Name prefix of the Distributed Flood Protection Profile to retrieve.
4039
* `context` - (Optional) The context which the object belongs to
41-
* `project_id` - (Required) The ID of the project which the object belongs to
40+
* `project_id` - (Required) The ID of the project which the object belongs to
4241

4342
## Attributes Reference
4443

Diff for: ‎website/docs/d/policy_distributed_vlan_connection.html.markdown renamed to ‎docs/data-sources/policy_distributed_vlan_connection.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "VPC"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_distributed_vlan_connection"
54
description: Policy distributed VLAN connection data source.
65
---

Diff for: ‎website/docs/d/policy_edge_cluster.html.markdown renamed to ‎docs/data-sources/policy_edge_cluster.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_edge cluster"
54
description: A policy Edge Cluster data source.
65
---
@@ -20,8 +19,8 @@ data "nsxt_policy_edge_cluster" "ec" {
2019
```
2120

2221
Note: This usage is for Global Manager only.
23-
```hcl
2422

23+
```hcl
2524
data "nsxt_policy_site" "paris" {
2625
display_name = "Paris"
2726
}

Diff for: ‎website/docs/d/policy_edge_node.html.markdown renamed to ‎docs/data-sources/policy_edge_node.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Fabric"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_edge node"
54
description: A policy Edge Node data source.
65
---

Diff for: ‎website/docs/d/policy_gateway_connection.html.markdown renamed to ‎docs/data-sources/policy_gateway_connection.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "VPC"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_connection"
54
description: Policy gateway connection data source.
65
---

Diff for: ‎website/docs/d/policy_gateway_dns_forwarder.html.markdown renamed to ‎docs/data-sources/policy_gateway_dns_forwarder.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "DNS"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_dns_forwarder"
54
description: A policy gateway DNS forwarder data source.
65
---
@@ -26,7 +25,7 @@ data "nsxt_policy_gateway_dns_forwarder" "my_dns_forwarder" {
2625
* `display_name` - (Optional) The Display Name of the gateway DNS forwarder to retrieve.
2726
* `gateway_path` - (Optional) Gateway Path for this Service.
2827
* `context` - (Optional) The context which the object belongs to
29-
* `project_id` - (Required) The ID of the project which the object belongs to
28+
* `project_id` - (Required) The ID of the project which the object belongs to
3029

3130
## Attributes Reference
3231

Diff for: ‎website/docs/d/policy_gateway_flood_protection_profile.html.markdown renamed to ‎docs/data-sources/policy_gateway_flood_protection_profile.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Beta"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_flood_protection_profile"
54
description: Policy Gateway Flood Protection Profile data source.
65
---
@@ -38,7 +37,7 @@ resource "nsxt_policy_gateway_flood_protection_profile" "test" {
3837
* `id` - (Optional) The ID of Gateway Flood Protection Profile to retrieve.
3938
* `display_name` - (Optional) The Display Name prefix of the Gateway Flood Protection Profile to retrieve.
4039
* `context` - (Optional) The context which the object belongs to
41-
* `project_id` - (Required) The ID of the project which the object belongs to
40+
* `project_id` - (Required) The ID of the project which the object belongs to
4241

4342
## Attributes Reference
4443

Diff for: ‎website/docs/d/policy_gateway_interface_realization_info.html.markdown renamed to ‎docs/data-sources/policy_gateway_interface_realization_info.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Realization"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_interface_realization"
54
description: A gateway interface realization information.
65
---
@@ -54,7 +53,7 @@ data "nsxt_policy_gateway_interface_realization" "info" {
5453
* `delay` - (Optional) Delay (in seconds) before realization polling is started. Default is set to 1.
5554
* `timeout` - (Optional) Timeout (in seconds) for realization polling. Default is set to 1200.
5655
* `context` - (Optional) The context which the object belongs to
57-
* `project_id` - (Required) The ID of the project which the object belongs to
56+
* `project_id` - (Required) The ID of the project which the object belongs to
5857

5958
## Attributes Reference
6059

Diff for: ‎website/docs/d/policy_gateway_locale_service.html.markdown renamed to ‎docs/data-sources/policy_gateway_locale_service.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
subcategory: "Gateways and Routing"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_locale_service"
54
description: A policy gateway locale service data source.
65
---
@@ -42,7 +41,7 @@ data "nsxt_policy_gateway_locale_service" "demoserv" {
4241
* `id` - (Optional) The ID of locale service gateway to retrieve.
4342
* `display_name` - (Optional) The Display Name or prefix of locale service to retrieve.
4443
* `context` - (Optional) The context which the object belongs to
45-
* `project_id` - (Required) The ID of the project which the object belongs to
44+
* `project_id` - (Required) The ID of the project which the object belongs to
4645

4746
## Attributes Reference
4847

Diff for: ‎website/docs/d/policy_gateway_policy.html.markdown renamed to ‎docs/data-sources/policy_gateway_policy.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
---
22
subcategory: "Firewall"
3-
layout: "nsxt"
43
page_title: "NSXT: policy_gateway_policy"
54
description: A policy Gateway Policy data source.
65
---
76

87
# nsxt_policy_gateway_policy
98

10-
This data source provides information about policy Gateway Policues configured on NSX.
9+
This data source provides information about policy Gateway Polices configured on NSX.
1110
This data source can be useful for fetching policy path to use in `nsxt_policy_predefined_gateway_policy` resource.
1211

1312
This data source is applicable to NSX Policy Manager, NSX Global Manager and VMC.
@@ -42,7 +41,7 @@ data "nsxt_policy_gateway_policy" "demopolicy" {
4241
* `category` - (Optional) Category of the policy to retrieve. May be useful to retrieve default policy.
4342
* `display_name` - (Optional) The Display Name prefix of the policy to retrieve.
4443
* `context` - (Optional) The context which the object belongs to
45-
* `project_id` - (Required) The ID of the project which the object belongs to
44+
* `project_id` - (Required) The ID of the project which the object belongs to
4645

4746
## Attributes Reference
4847

0 commit comments

Comments
 (0)