update docs

OctopusDeployLabs · Jul 19, 2024 · 70a6a5f · 70a6a5f
1 parent 223f6aa
commit 70a6a5f
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -186,6 +186,11 @@ Documentation is auto-generated by the [tfplugindocs CLI](https://github.com/has
 $ make docs
 ```
 
+or
+```shell
+go generate main.go
+```
+
 ## 🤝 Contributions
 
 Contributions are welcome! :heart: Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.
diff --git a/docs/data-sources/tenants.md b/docs/data-sources/tenants.md
@@ -42,16 +42,7 @@ Read-Only:
 - `description` (String) The description of this tenant.
 - `id` (String) The unique ID for this resource.
 - `name` (String) The name of this resource.
-- `project_environment` (Set of Object) (see [below for nested schema](#nestedatt--tenants--project_environment))
 - `space_id` (String) The space ID associated with this resource.
 - `tenant_tags` (List of String) A list of tenant tags associated with this resource.
 
-<a id="nestedatt--tenants--project_environment"></a>
-### Nested Schema for `tenants.project_environment`
-
-Read-Only:
-
-- `environments` (List of String)
-- `project_id` (String)
-
 
diff --git a/docs/resources/tenant.md b/docs/resources/tenant.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "octopusdeploy_tenant Resource - terraform-provider-octopusdeploy"
 subcategory: ""
 description: |-
@@ -10,8 +9,6 @@ description: |-
 
 This resource manages tenants in Octopus Deploy.
 
-
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -24,16 +21,7 @@ This resource manages tenants in Octopus Deploy.
 - `cloned_from_tenant_id` (String) The ID of the tenant from which this tenant was cloned.
 - `description` (String) The description of this tenant.
 - `id` (String) The unique ID for this resource.
-- `project_environment` (Block Set) (see [below for nested schema](#nestedblock--project_environment))
 - `space_id` (String) The space ID associated with this resource.
 - `tenant_tags` (List of String) A list of tenant tags associated with this resource.
 
-<a id="nestedblock--project_environment"></a>
-### Nested Schema for `project_environment`
-
-Required:
-
-- `environments` (List of String) A list of environment IDs associated with this tenant through a project.
-- `project_id` (String) The project ID associated with this tenant.
-
-
+~> **NOTE property `project_environment` deprecated:** The `project_environment` property has been replaced by the `octopusdeploy_tenant_project` resource to allow more advanced provisioning scenarioes. 
diff --git a/docs/resources/tenant_project.md b/docs/resources/tenant_project.md
@@ -0,0 +1,32 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "octopusdeploy_tenant_project Resource - terraform-provider-octopusdeploy"
+subcategory: ""
+description: |-
+  This resource represents the connection between tenants and projects.
+---
+
+# octopusdeploy_tenant_project (Resource)
+
+This resource represents the connection between tenants and projects.
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project_id` (String) The project ID associated with this tenant.
+- `tenant_id` (String) The tenant ID associated with this tenant.
+
+### Optional
+
+- `environment_ids` (List of String) The environment ID associated with this tenant.
+- `space_id` (String) The space ID associated with this resource.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+
diff --git a/...oy/resource_tenant project_environment.go → octopusdeploy/resource_tenant project.go b/...oy/resource_tenant project_environment.go → octopusdeploy/resource_tenant project.go
@@ -17,7 +17,7 @@ func resourceTenantProject() *schema.Resource {
 	return &schema.Resource{
 		CreateContext: resourceTenantProjectCreate,
 		DeleteContext: resourceTenantProjectDelete,
-		Description:   "This resource manages tenants in Octopus Deploy.",
+		Description:   "This resource represents the connection between tenants and projects.",
 		Importer:      getImporter(),
 		ReadContext:   resourceTenantProjectRead,
 		UpdateContext: resourceTenantProjectUpdate,

diff --git a/templates/resources/tenant.md.tmpl b/templates/resources/tenant.md.tmpl
@@ -0,0 +1,14 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+{{ .SchemaMarkdown | trimspace }}
+
+~> **NOTE property `project_environment` deprecated:** The `project_environment` property has been replaced by the `octopusdeploy_tenant_project` resource to allow more advanced provisioning scenarioes.