Merge pull request #68 from arangodb-managed/OAS-4755.documentation-changes

adoi · web-flow · commit 441989eb152a · 2022-06-23T15:33:37.000+02:00
OAS-4755 | change documentation for source and version after major release
diff --git a/README.md b/README.md
@@ -1,32 +1,19 @@
-# ArangoDB Oasis Terraform Provider
+# ArangoDB Oasis Terraform Provider [![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/arangodb-managed/terraform-provider-oasis?label=release)](https://github.com/arangodb-managed/terraform-provider-oasis/releases) [![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb-managed/terraform-provider-oasis/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/arangodb-managed/terraform-provider-oasis/tree/master)
 
-![ArangoDB Oasis](https://cloud.arangodb.com/assets/logos/arangodb-oasis-logo-whitebg-right.png)
 
-The Terraform Oasis provider is a plugin for Terraform that allows for the full lifecycle management of ArangoDB Cloud resources.
-
-## Project status: Preview
-
-Note that this provider is currently in preview.
+![ArangoDB Oasis](https://cloud.arangodb.com/assets/logos/arangodb-oasis-logo-whitebg-right.png) 
 
-**That means that its API may still change.**
+The Terraform Oasis provider is a plugin for Terraform that allows for the full lifecycle management of ArangoDB Cloud resources.
 
-We welcome your feedback!
+## Project status: GA
 
 ## Maintainers
 
 This provider plugin is maintained by the team at [ArangoDB](https://www.arangodb.com/).
 
 ## Installation
 
-Downloading the [latest released binaries](https://github.com/arangodb-managed/terraform-provider-oasis/releases),
-extract the zip archive and install the binary for your platform in your preferred location.
-
-Or to build from source, run:
-
-```bash
-git clone https://github.com/arangodb-managed/terraform-provider-oasis.git
-make
-```
+Please follow the [Getting Started](https://registry.terraform.io/providers/arangodb-managed/oasis/latest/docs/guides/getting-started) guide in the official documentation page.
 
 ## Requirements
 
diff --git a/docs/data-sources/backup.md b/docs/data-sources/backup.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/cloud_provider.md b/docs/data-sources/cloud_provider.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/example_datasets.md b/docs/data-sources/example_datasets.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/organization.md b/docs/data-sources/organization.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/region.md b/docs/data-sources/region.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/data-sources/terms_and_conditions.md b/docs/data-sources/terms_and_conditions.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md
@@ -16,6 +16,16 @@ You need to supply proper credentials to the provider before it can be used. API
 Log in to the Oasis dashboard and open the [**API Keys**](https://cloud.arangodb.com/dashboard/user/api-keys) tab of your user account. Click the **New API key** button to generate a new key, which can be used with ArangoDB's public API.
 
 ```hcl
+terraform {
+  required_version = ">= 0.13.0"
+  required_providers {
+    oasis = {
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
+    }
+  }
+}
+
 provider "oasis" {
   api_key_id     = "" // API Key ID generated in Oasis platform
   api_key_secret = "" // API Key Secret generated in Oasis platform
diff --git a/docs/guides/setup.md b/docs/guides/setup.md
@@ -13,8 +13,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/index.md b/docs/index.md
@@ -20,8 +20,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/auditlog.md b/docs/resources/auditlog.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/backup.md b/docs/resources/backup.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/backup_policy.md b/docs/resources/backup_policy.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/certificate.md b/docs/resources/certificate.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/deployment.md b/docs/resources/deployment.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/iam_group.md b/docs/resources/iam_group.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/iam_role.md b/docs/resources/iam_role.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/ipallowlist.md b/docs/resources/ipallowlist.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/organization.md b/docs/resources/organization.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/organization_invite.md b/docs/resources/organization_invite.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/docs/resources/private_endpoint.md b/docs/resources/private_endpoint.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0",
     }
   }
 }
diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -17,8 +17,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_backup/data-source.tf b/examples/data-sources/oasis_backup/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_cloud_provider/data-source.tf b/examples/data-sources/oasis_cloud_provider/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_example_datasets/data-source.tf b/examples/data-sources/oasis_example_datasets/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_organization/data-source.tf b/examples/data-sources/oasis_organization/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_project/data-source.tf b/examples/data-sources/oasis_project/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_region/data-source.tf b/examples/data-sources/oasis_region/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/data-sources/oasis_terms_and_conditions/data-source.tf b/examples/data-sources/oasis_terms_and_conditions/data-source.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/resources/oasis_auditlog/resource.tf b/examples/resources/oasis_auditlog/resource.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/resources/oasis_backup/resource.tf b/examples/resources/oasis_backup/resource.tf
@@ -2,8 +2,8 @@ terraform {
   required_version = ">= 0.13.0"
   required_providers {
     oasis = {
-      source  = "arangodb.com/managed/oasis"
-      version = ">=1.5.1"
+      source  = "arangodb-managed/oasis"
+      version = ">=2.1.0"
     }
   }
 }
diff --git a/examples/resources/oasis_backup_policy/resource.tf b/examples/resources/oasis_backup_policy/resource.tf
diff --git a/examples/resources/oasis_certificate/resource.tf b/examples/resources/oasis_certificate/resource.tf
diff --git a/examples/resources/oasis_deployment/resource.tf b/examples/resources/oasis_deployment/resource.tf
diff --git a/examples/resources/oasis_iam_group/resource.tf b/examples/resources/oasis_iam_group/resource.tf
diff --git a/examples/resources/oasis_iam_role/resource.tf b/examples/resources/oasis_iam_role/resource.tf
diff --git a/examples/resources/oasis_ipallowlist/resource.tf b/examples/resources/oasis_ipallowlist/resource.tf
diff --git a/examples/resources/oasis_organization/resource.tf b/examples/resources/oasis_organization/resource.tf
diff --git a/examples/resources/oasis_organization_invite/resource.tf b/examples/resources/oasis_organization_invite/resource.tf
diff --git a/examples/resources/oasis_private_endpoint/resource.tf b/examples/resources/oasis_private_endpoint/resource.tf
diff --git a/examples/resources/oasis_project/resource.tf b/examples/resources/oasis_project/resource.tf
diff --git a/templates/guides/getting-started.md.tmpl b/templates/guides/getting-started.md.tmpl
diff --git a/templates/guides/setup.md.tmpl b/templates/guides/setup.md.tmpl

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ terraform {`
`17`	`17`	`required_version = ">= 0.13.0"`
`18`	`18`	`required_providers {`
`19`	`19`	`oasis = {`
`20`		`- source = "arangodb.com/managed/oasis"`
`21`		`- version = ">=1.5.1"`
	`20`	`+ source = "arangodb-managed/oasis"`
	`21`	`+ version = ">=2.1.0"`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ terraform {`
`13`	`13`	`required_version = ">= 0.13.0"`
`14`	`14`	`required_providers {`
`15`	`15`	`oasis = {`
`16`		`- source = "arangodb.com/managed/oasis"`
`17`		`- version = ">=1.5.1"`
	`16`	`+ source = "arangodb-managed/oasis"`
	`17`	`+ version = ">=2.1.0"`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`	`}`