From 612ad45a30d79778d9ad0d96d6d1aad1fd9dd44e Mon Sep 17 00:00:00 2001 From: Dan Petersen Date: Wed, 10 Feb 2021 05:05:26 +0100 Subject: [PATCH] Update docs --- CHANGELOG.md | 6 ++++++ ...ment_alias.md => virtual_environment_cluster_alias.md} | 6 +++--- ..._aliases.md => virtual_environment_cluster_aliases.md} | 6 +++--- docs/data-sources/virtual_environment_datastores.md | 6 +++--- docs/data-sources/virtual_environment_dns.md | 6 +++--- docs/data-sources/virtual_environment_group.md | 6 +++--- docs/data-sources/virtual_environment_groups.md | 6 +++--- docs/data-sources/virtual_environment_hosts.md | 6 +++--- docs/data-sources/virtual_environment_nodes.md | 6 +++--- docs/data-sources/virtual_environment_pool.md | 6 +++--- docs/data-sources/virtual_environment_pools.md | 6 +++--- docs/data-sources/virtual_environment_role.md | 6 +++--- docs/data-sources/virtual_environment_roles.md | 6 +++--- docs/data-sources/virtual_environment_time.md | 6 +++--- docs/data-sources/virtual_environment_user.md | 6 +++--- docs/data-sources/virtual_environment_users.md | 6 +++--- docs/data-sources/virtual_environment_version.md | 6 +++--- docs/resources/virtual_environment_certificate.md | 8 ++++---- ...ment_alias.md => virtual_environment_cluster_alias.md} | 8 ++++---- ...ment_ipset.md => virtual_environment_cluster_ipset.md} | 8 ++++---- docs/resources/virtual_environment_container.md | 8 ++++---- docs/resources/virtual_environment_dns.md | 8 ++++---- docs/resources/virtual_environment_file.md | 8 ++++---- docs/resources/virtual_environment_group.md | 8 ++++---- docs/resources/virtual_environment_hosts.md | 8 ++++---- docs/resources/virtual_environment_pool.md | 6 +++--- docs/resources/virtual_environment_role.md | 6 +++--- docs/resources/virtual_environment_time.md | 6 +++--- docs/resources/virtual_environment_user.md | 6 +++--- docs/resources/{vm.md => virtual_environment_vm.md} | 6 +++--- ...o => data_source_virtual_environment_cluster_alias.go} | 0 ...data_source_virtual_environment_cluster_alias_test.go} | 0 ...=> data_source_virtual_environment_cluster_aliases.go} | 0 ...ta_source_virtual_environment_cluster_aliases_test.go} | 0 proxmoxtf/version.go | 2 +- 35 files changed, 102 insertions(+), 96 deletions(-) rename docs/data-sources/{virtual_environment_alias.md => virtual_environment_cluster_alias.md} (72%) rename docs/data-sources/{virtual_environment_aliases.md => virtual_environment_cluster_aliases.md} (69%) rename docs/resources/{virtual_environment_alias.md => virtual_environment_cluster_alias.md} (82%) rename docs/resources/{virtual_environment_ipset.md => virtual_environment_cluster_ipset.md} (85%) rename docs/resources/{vm.md => virtual_environment_vm.md} (99%) rename proxmoxtf/{data_source_virtual_environment_alias.go => data_source_virtual_environment_cluster_alias.go} (100%) rename proxmoxtf/{data_source_virtual_environment_alias_test.go => data_source_virtual_environment_cluster_alias_test.go} (100%) rename proxmoxtf/{data_source_virtual_environment_aliases.go => data_source_virtual_environment_cluster_aliases.go} (100%) rename proxmoxtf/{data_source_virtual_environment_aliases_test.go => data_source_virtual_environment_cluster_aliases_test.go} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 256a612..991f28c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## v0.4.1 + +OTHER: + +* provider/docs: Fix issue with navigational link titles in Terraform Registry + ## v0.4.0 FEATURES: diff --git a/docs/data-sources/virtual_environment_alias.md b/docs/data-sources/virtual_environment_cluster_alias.md similarity index 72% rename from docs/data-sources/virtual_environment_alias.md rename to docs/data-sources/virtual_environment_cluster_alias.md index bbf5a60..801d614 100644 --- a/docs/data-sources/virtual_environment_alias.md +++ b/docs/data-sources/virtual_environment_cluster_alias.md @@ -1,13 +1,13 @@ --- layout: page -title: Alias -permalink: /data-sources/alias +title: proxmox_virtual_environment_cluster_alias +permalink: /data-sources/virtual_environment_cluster_alias nav_order: 1 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Alias +# Data Source: proxmox_virtual_environment_cluster_alias Retrieves information about a specific alias. diff --git a/docs/data-sources/virtual_environment_aliases.md b/docs/data-sources/virtual_environment_cluster_aliases.md similarity index 69% rename from docs/data-sources/virtual_environment_aliases.md rename to docs/data-sources/virtual_environment_cluster_aliases.md index 68fb7ec..a987b04 100644 --- a/docs/data-sources/virtual_environment_aliases.md +++ b/docs/data-sources/virtual_environment_cluster_aliases.md @@ -1,13 +1,13 @@ --- layout: page -title: Aliases -permalink: /data-sources/aliases +title: proxmox_virtual_environment_cluster_aliases +permalink: /data-sources/virtual_environment_cluster_aliases nav_order: 2 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Aliases +# Data Source: proxmox_virtual_environment_cluster_aliases Retrieves the identifiers for all the available aliases. diff --git a/docs/data-sources/virtual_environment_datastores.md b/docs/data-sources/virtual_environment_datastores.md index 2b9cc74..3d216e5 100644 --- a/docs/data-sources/virtual_environment_datastores.md +++ b/docs/data-sources/virtual_environment_datastores.md @@ -1,13 +1,13 @@ --- layout: page -title: Datastores -permalink: /data-sources/datastores +title: proxmox_virtual_environment_datastores +permalink: /data-sources/virtual_environment_datastores nav_order: 3 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Datastores +# Data Source: proxmox_virtual_environment_datastores Retrieves information about all the datastores available to a specific node. diff --git a/docs/data-sources/virtual_environment_dns.md b/docs/data-sources/virtual_environment_dns.md index bc65150..a393e4d 100644 --- a/docs/data-sources/virtual_environment_dns.md +++ b/docs/data-sources/virtual_environment_dns.md @@ -1,13 +1,13 @@ --- layout: page -title: DNS -permalink: /data-sources/dns +title: proxmox_virtual_environment_dns +permalink: /data-sources/virtual_environment_dns nav_order: 4 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: DNS +# Data Source: proxmox_virtual_environment_dns Retrieves the DNS configuration for a specific node. diff --git a/docs/data-sources/virtual_environment_group.md b/docs/data-sources/virtual_environment_group.md index 27b517b..548cdf5 100644 --- a/docs/data-sources/virtual_environment_group.md +++ b/docs/data-sources/virtual_environment_group.md @@ -1,13 +1,13 @@ --- layout: page -title: Group -permalink: /data-sources/group +title: proxmox_virtual_environment_group +permalink: /data-sources/virtual_environment_group nav_order: 5 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Group +# Data Source: proxmox_virtual_environment_group Retrieves information about a specific user group. diff --git a/docs/data-sources/virtual_environment_groups.md b/docs/data-sources/virtual_environment_groups.md index 524a25a..b1045ed 100644 --- a/docs/data-sources/virtual_environment_groups.md +++ b/docs/data-sources/virtual_environment_groups.md @@ -1,13 +1,13 @@ --- layout: page -title: Groups -permalink: /data-sources/groups +title: proxmox_virtual_environment_groups +permalink: /data-sources/virtual_environment_groups nav_order: 6 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Groups +# Data Source: proxmox_virtual_environment_groups Retrieves basic information about all available user groups. diff --git a/docs/data-sources/virtual_environment_hosts.md b/docs/data-sources/virtual_environment_hosts.md index ccc7376..f18abec 100644 --- a/docs/data-sources/virtual_environment_hosts.md +++ b/docs/data-sources/virtual_environment_hosts.md @@ -1,13 +1,13 @@ --- layout: page -title: Hosts -permalink: /data-sources/hosts +title: proxmox_virtual_environment_hosts +permalink: /data-sources/virtual_environment_hosts nav_order: 7 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Hosts +# Data Source: proxmox_virtual_environment_hosts Retrieves all the host entries from a specific node. diff --git a/docs/data-sources/virtual_environment_nodes.md b/docs/data-sources/virtual_environment_nodes.md index d964879..5d2c695 100644 --- a/docs/data-sources/virtual_environment_nodes.md +++ b/docs/data-sources/virtual_environment_nodes.md @@ -1,13 +1,13 @@ --- layout: page -title: Nodes -permalink: /data-sources/nodes +title: proxmox_virtual_environment_nodes +permalink: /data-sources/virtual_environment_nodes nav_order: 8 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Nodes +# Data Source: proxmox_virtual_environment_nodes Retrieves information about all available nodes. diff --git a/docs/data-sources/virtual_environment_pool.md b/docs/data-sources/virtual_environment_pool.md index 394e1bb..2d03440 100644 --- a/docs/data-sources/virtual_environment_pool.md +++ b/docs/data-sources/virtual_environment_pool.md @@ -1,13 +1,13 @@ --- layout: page -title: Pool -permalink: /data-sources/pool +title: proxmox_virtual_environment_pool +permalink: /data-sources/virtual_environment_pool nav_order: 9 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Pool +# Data Source: proxmox_virtual_environment_pool Retrieves information about a specific resource pool. diff --git a/docs/data-sources/virtual_environment_pools.md b/docs/data-sources/virtual_environment_pools.md index 5b712a5..f105981 100644 --- a/docs/data-sources/virtual_environment_pools.md +++ b/docs/data-sources/virtual_environment_pools.md @@ -1,13 +1,13 @@ --- layout: page -title: Pools -permalink: /data-sources/pools +title: proxmox_virtual_environment_pools +permalink: /data-sources/virtual_environment_pools nav_order: 10 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Pools +# Data Source: proxmox_virtual_environment_pools Retrieves the identifiers for all the available resource pools. diff --git a/docs/data-sources/virtual_environment_role.md b/docs/data-sources/virtual_environment_role.md index 24cbbff..e0d3f4e 100644 --- a/docs/data-sources/virtual_environment_role.md +++ b/docs/data-sources/virtual_environment_role.md @@ -1,13 +1,13 @@ --- layout: page -title: Role -permalink: /data-sources/role +title: proxmox_virtual_environment_role +permalink: /data-sources/virtual_environment_role nav_order: 11 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Role +# Data Source: proxmox_virtual_environment_role Retrieves information about a specific role. diff --git a/docs/data-sources/virtual_environment_roles.md b/docs/data-sources/virtual_environment_roles.md index fb0fc4b..47e5edb 100644 --- a/docs/data-sources/virtual_environment_roles.md +++ b/docs/data-sources/virtual_environment_roles.md @@ -1,13 +1,13 @@ --- layout: page -title: Roles -permalink: /data-sources/roles +title: proxmox_virtual_environment_roles +permalink: /data-sources/virtual_environment_roles nav_order: 12 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Roles +# Data Source: proxmox_virtual_environment_roles Retrieves information about all the available roles. diff --git a/docs/data-sources/virtual_environment_time.md b/docs/data-sources/virtual_environment_time.md index b580034..3a2e359 100644 --- a/docs/data-sources/virtual_environment_time.md +++ b/docs/data-sources/virtual_environment_time.md @@ -1,13 +1,13 @@ --- layout: page -title: Time -permalink: /data-sources/time +title: proxmox_virtual_environment_time +permalink: /data-sources/virtual_environment_time nav_order: 13 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Time +# Data Source: proxmox_virtual_environment_time Retrieves the current time for a specific node. diff --git a/docs/data-sources/virtual_environment_user.md b/docs/data-sources/virtual_environment_user.md index 5c15995..dc6744c 100644 --- a/docs/data-sources/virtual_environment_user.md +++ b/docs/data-sources/virtual_environment_user.md @@ -1,13 +1,13 @@ --- layout: page -title: User -permalink: /data-sources/user +title: proxmox_virtual_environment_user +permalink: /data-sources/virtual_environment_user nav_order: 14 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: User +# Data Source: proxmox_virtual_environment_user Retrieves information about a specific user. diff --git a/docs/data-sources/virtual_environment_users.md b/docs/data-sources/virtual_environment_users.md index 2768738..1d2915c 100644 --- a/docs/data-sources/virtual_environment_users.md +++ b/docs/data-sources/virtual_environment_users.md @@ -1,13 +1,13 @@ --- layout: page -title: Users -permalink: /data-sources/users +title: proxmox_virtual_environment_users +permalink: /data-sources/virtual_environment_users nav_order: 15 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Users +# Data Source: proxmox_virtual_environment_users Retrieves information about all the available users. diff --git a/docs/data-sources/virtual_environment_version.md b/docs/data-sources/virtual_environment_version.md index 45c43da..d586dff 100644 --- a/docs/data-sources/virtual_environment_version.md +++ b/docs/data-sources/virtual_environment_version.md @@ -1,13 +1,13 @@ --- layout: page -title: Version -permalink: /data-sources/version +title: proxmox_virtual_environment_version +permalink: /data-sources/virtual_environment_version nav_order: 16 parent: Data Sources subcategory: Virtual Environment --- -# Data Source: Version +# Data Source: proxmox_virtual_environment_version Retrieves the version information from the API endpoint. diff --git a/docs/resources/virtual_environment_certificate.md b/docs/resources/virtual_environment_certificate.md index 148801d..b48aad3 100644 --- a/docs/resources/virtual_environment_certificate.md +++ b/docs/resources/virtual_environment_certificate.md @@ -1,13 +1,13 @@ --- layout: page -title: Certificate -permalink: /resources/certificate -nav_order: 2 +title: proxmox_virtual_environment_certificate +permalink: /resources/virtual_environment_certificate +nav_order: 1 parent: Resources subcategory: Virtual Environment --- -# Resource: Certificate +# Resource: proxmox_virtual_environment_certificate Manages the custom SSL/TLS certificate for a specific node. diff --git a/docs/resources/virtual_environment_alias.md b/docs/resources/virtual_environment_cluster_alias.md similarity index 82% rename from docs/resources/virtual_environment_alias.md rename to docs/resources/virtual_environment_cluster_alias.md index 319914e..8df0707 100644 --- a/docs/resources/virtual_environment_alias.md +++ b/docs/resources/virtual_environment_cluster_alias.md @@ -1,13 +1,13 @@ --- layout: page -title: Alias -permalink: /ressources/alias -nav_order: 1 +title: proxmox_virtual_environment_cluster_alias +permalink: /resources/virtual_environment_cluster_alias +nav_order: 2 parent: Resources subcategory: Virtual Environment --- -# Resource: Alias +# Resource: proxmox_virtual_environment_cluster_alias Aliases are used to see what devices or group of devices are affected by a rule. We can create aliases to identify an IP address or a network. diff --git a/docs/resources/virtual_environment_ipset.md b/docs/resources/virtual_environment_cluster_ipset.md similarity index 85% rename from docs/resources/virtual_environment_ipset.md rename to docs/resources/virtual_environment_cluster_ipset.md index 935539f..9552c31 100644 --- a/docs/resources/virtual_environment_ipset.md +++ b/docs/resources/virtual_environment_cluster_ipset.md @@ -1,13 +1,13 @@ --- layout: page -title: IPSet -permalink: /ressources/ipset -nav_order: 8 +title: proxmox_virtual_environment_cluster_ipset +permalink: /resources/virtual_environment_cluster_ipset +nav_order: 3 parent: Resources subcategory: Virtual Environment --- -# Resource: IPSet +# Resource: proxmox_virtual_environment_cluster_ipset An IPSet allows us to group multiple IP addresses, IP subnets and aliases. diff --git a/docs/resources/virtual_environment_container.md b/docs/resources/virtual_environment_container.md index ee1b530..308f548 100644 --- a/docs/resources/virtual_environment_container.md +++ b/docs/resources/virtual_environment_container.md @@ -1,13 +1,13 @@ --- layout: page -title: Container -permalink: /resources/container -nav_order: 3 +title: proxmox_virtual_environment_container +permalink: /resources/virtual_environment_container +nav_order: 4 parent: Resources subcategory: Virtual Environment --- -# Resource: Container +# Resource: proxmox_virtual_environment_container Manages a container. diff --git a/docs/resources/virtual_environment_dns.md b/docs/resources/virtual_environment_dns.md index 49bdf12..fc6ef8e 100644 --- a/docs/resources/virtual_environment_dns.md +++ b/docs/resources/virtual_environment_dns.md @@ -1,13 +1,13 @@ --- layout: page -title: DNS -permalink: /resources/dns -nav_order: 4 +title: proxmox_virtual_environment_dns +permalink: /resources/virtual_environment_dns +nav_order: 5 parent: Resources subcategory: Virtual Environment --- -# Resource: DNS +# Resource: proxmox_virtual_environment_dns Manages the DNS configuration for a specific node. diff --git a/docs/resources/virtual_environment_file.md b/docs/resources/virtual_environment_file.md index 34ea946..e310135 100644 --- a/docs/resources/virtual_environment_file.md +++ b/docs/resources/virtual_environment_file.md @@ -1,13 +1,13 @@ --- layout: page -title: File -permalink: /resources/file -nav_order: 5 +title: proxmox_virtual_environment_file +permalink: /resources/virtual_environment_file +nav_order: 6 parent: Resources subcategory: Virtual Environment --- -# Resource: File +# Resource: proxmox_virtual_environment_file Manages a file. diff --git a/docs/resources/virtual_environment_group.md b/docs/resources/virtual_environment_group.md index 1e13cf6..c3a6b67 100644 --- a/docs/resources/virtual_environment_group.md +++ b/docs/resources/virtual_environment_group.md @@ -1,13 +1,13 @@ --- layout: page -title: Group -permalink: /resources/group -nav_order: 6 +title: proxmox_virtual_environment_group +permalink: /resources/virtual_environment_group +nav_order: 7 parent: Resources subcategory: Virtual Environment --- -# Resource: Group +# Resource: proxmox_virtual_environment_group Manages a user group. diff --git a/docs/resources/virtual_environment_hosts.md b/docs/resources/virtual_environment_hosts.md index e9805ef..d36eaf9 100644 --- a/docs/resources/virtual_environment_hosts.md +++ b/docs/resources/virtual_environment_hosts.md @@ -1,13 +1,13 @@ --- layout: page -title: Hosts -permalink: /resources/hosts -nav_order: 7 +title: proxmox_virtual_environment_hosts +permalink: /resources/virtual_environment_hosts +nav_order: 8 parent: Resources subcategory: Virtual Environment --- -# Resource: Hosts +# Resource: proxmox_virtual_environment_hosts Manages the host entries on a specific node. diff --git a/docs/resources/virtual_environment_pool.md b/docs/resources/virtual_environment_pool.md index 31bbb69..353a55c 100644 --- a/docs/resources/virtual_environment_pool.md +++ b/docs/resources/virtual_environment_pool.md @@ -1,13 +1,13 @@ --- layout: page -title: Pool -permalink: /resources/pool +title: proxmox_virtual_environment_pool +permalink: /resources/virtual_environment_pool nav_order: 9 parent: Resources subcategory: Virtual Environment --- -# Resource: Pool +# Resource: proxmox_virtual_environment_pool Manages a resource pool. diff --git a/docs/resources/virtual_environment_role.md b/docs/resources/virtual_environment_role.md index 38bf541..dc844c1 100644 --- a/docs/resources/virtual_environment_role.md +++ b/docs/resources/virtual_environment_role.md @@ -1,13 +1,13 @@ --- layout: page -title: Role -permalink: /resources/role +title: proxmox_virtual_environment_role +permalink: /resources/virtual_environment_role nav_order: 10 parent: Resources subcategory: Virtual Environment --- -# Resource: Role +# Resource: proxmox_virtual_environment_role Manages a role. diff --git a/docs/resources/virtual_environment_time.md b/docs/resources/virtual_environment_time.md index 1872063..76104c8 100644 --- a/docs/resources/virtual_environment_time.md +++ b/docs/resources/virtual_environment_time.md @@ -1,13 +1,13 @@ --- layout: page -title: Time -permalink: /resources/time +title: proxmox_virtual_environment_time +permalink: /resources/virtual_environment_time nav_order: 11 parent: Resources subcategory: Virtual Environment --- -# Resource: Time +# Resource: proxmox_virtual_environment_time Manages the time for a specific node. diff --git a/docs/resources/virtual_environment_user.md b/docs/resources/virtual_environment_user.md index e918454..b6786cd 100644 --- a/docs/resources/virtual_environment_user.md +++ b/docs/resources/virtual_environment_user.md @@ -1,13 +1,13 @@ --- layout: page -title: User -permalink: /resources/user +title: proxmox_virtual_environment_user +permalink: /resources/virtual_environment_user nav_order: 12 parent: Resources subcategory: Virtual Environment --- -# Resource: User +# Resource: proxmox_virtual_environment_user Manages a user. diff --git a/docs/resources/vm.md b/docs/resources/virtual_environment_vm.md similarity index 99% rename from docs/resources/vm.md rename to docs/resources/virtual_environment_vm.md index 5b940dd..e1a8426 100644 --- a/docs/resources/vm.md +++ b/docs/resources/virtual_environment_vm.md @@ -1,13 +1,13 @@ --- layout: page -title: VM -permalink: /resources/vm +title: proxmox_virtual_environment_vm +permalink: /resources/virtual_environment_vm nav_order: 13 parent: Resources subcategory: Virtual Environment --- -# Resource: VM +# Resource: proxmox_virtual_environment_vm Manages a virtual machine. diff --git a/proxmoxtf/data_source_virtual_environment_alias.go b/proxmoxtf/data_source_virtual_environment_cluster_alias.go similarity index 100% rename from proxmoxtf/data_source_virtual_environment_alias.go rename to proxmoxtf/data_source_virtual_environment_cluster_alias.go diff --git a/proxmoxtf/data_source_virtual_environment_alias_test.go b/proxmoxtf/data_source_virtual_environment_cluster_alias_test.go similarity index 100% rename from proxmoxtf/data_source_virtual_environment_alias_test.go rename to proxmoxtf/data_source_virtual_environment_cluster_alias_test.go diff --git a/proxmoxtf/data_source_virtual_environment_aliases.go b/proxmoxtf/data_source_virtual_environment_cluster_aliases.go similarity index 100% rename from proxmoxtf/data_source_virtual_environment_aliases.go rename to proxmoxtf/data_source_virtual_environment_cluster_aliases.go diff --git a/proxmoxtf/data_source_virtual_environment_aliases_test.go b/proxmoxtf/data_source_virtual_environment_cluster_aliases_test.go similarity index 100% rename from proxmoxtf/data_source_virtual_environment_aliases_test.go rename to proxmoxtf/data_source_virtual_environment_cluster_aliases_test.go diff --git a/proxmoxtf/version.go b/proxmoxtf/version.go index 6c80429..31e9295 100644 --- a/proxmoxtf/version.go +++ b/proxmoxtf/version.go @@ -9,5 +9,5 @@ const ( TerraformProviderName = "terraform-provider-proxmox" // TerraformProviderVersion specifies the version number. - TerraformProviderVersion = "0.4.0" + TerraformProviderVersion = "0.4.1" )