Updated documentation

OctopusDeployLabs · Dec 15, 2020 · 04b59dd · 04b59dd
1 parent a002cdb
commit 04b59dd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -11,8 +11,6 @@ A GitHub action has been added to this project which initializes an instance of
 
 ## Downloading & Installing
 
-As this provider is still under development, you will need to manually download it.
-
 There are compiled binaries for most platforms in [Releases](https://github.com/OctopusDeploy/terraform-provider-octopusdeploy/releases).
 
 To use it, extract the binary for your platform into the same folder as your `.tf` file(s) will be located, then run `terraform init`.
@@ -90,14 +88,4 @@ resource "octopusdeploy_environment" "Env3" {
   provider = "octopusdeploy.space_product1"
   name     = "TestEnv3"
 }
-```
-
-## Data Sources
-
-* [octopusdeploy_environment](docs/provider/data_sources/environment.md)
-* [octopusdeploy_lifecycle](docs/provider/data_sources/lifecycle.md)
-
-## Provider Resources
-
-* [octopusdeploy_environment](docs/provider/resources/environment.md)
-* [octopusdeploy_lifecycle](docs/provider/resources/lifecycle.md)
+```
diff --git a/docs/resources/azure_web_app_deployment_target.md b/docs/resources/azure_web_app_deployment_target.md
@@ -9,7 +9,18 @@ description: |-
 
 This resource manages Azure web app deployment targets in Octopus Deploy.
 
-
+## Example Usage
+
+```terraform
+resource "octopusdeploy_azure_web_app_deployment_target" "example" {
+  account_id                        = "Accounts-123"
+  name                              = "Azure Web App Deployment Target (OK to Delete)"
+  resource_group_name               = "[resource-group-name]"
+  roles                             = ["Development Team", "System Administrators"]
+  tenanted_deployment_participation = "Untenanted"
+  web_app_name                      = "[web_app_name]"
+}
+```
 
 ## Schema
 

diff --git a/examples/resources/octopusdeploy_azure_web_app_deployment_target/resource.tf b/examples/resources/octopusdeploy_azure_web_app_deployment_target/resource.tf
@@ -0,0 +1,8 @@
+resource "octopusdeploy_azure_web_app_deployment_target" "example" {
+  account_id                        = "Accounts-123"
+  name                              = "Azure Web App Deployment Target (OK to Delete)"
+  resource_group_name               = "[resource-group-name]"
+  roles                             = ["Development Team", "System Administrators"]
+  tenanted_deployment_participation = "Untenanted"
+  web_app_name                      = "[web_app_name]"
+}