chore: update docs and comments (#11)

Author: ecmadao

README.md

@@ -2,6 +2,12 @@
 
 This repository is the Terraform provider for Bytebase.
 
+## Usage
+
+You can download this provider at [registry.terraform.io](https://registry.terraform.io/providers/bytebase/bytebase).
+
+Please follow [Manage Bytebase with Terraform](https://www.bytebase.com/docs/get-started/terraform) to use the provider.
+
 ## Development
 
 ### Prerequisites

docs/index.md

@@ -10,6 +10,8 @@ description: |-
 
 This is the Bytebase Terraform provider to manage your Bytebase resources. For now we support manage the Bytebase instances and environments.
 
+Please follow [Manage Bytebase with Terraform](https://www.bytebase.com/docs/get-started/terraform) to use the provider.
+
 ## Example Usage
 
 > Require Terraform 0.13+
@@ -62,7 +64,7 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ### Optional
 
-- `url`: Required. The [external URL](/docs/get-started/install/external-url) for your Bytebase server. Alternatively, you can set `BYTEBASE_URL` environment variable.
+- `url`: Required. The [external URL](https://www.bytebase.com/docs/get-started/install/external-url) for your Bytebase server. Alternatively, you can set `BYTEBASE_URL` environment variable.
 - `service_account`: Required. The Bytebase service account email. The user must have **Owner** or **DBA** role. Alternatively, you can set `BYTEBASE_SERVICE_ACCOUNT` environment variable.
 - `service_key`: Required. The Bytebase service account key. Alternatively, you can set `BYTEBASE_SERVICE_KEY` environment variable.
 

examples/environments/main.tf

@@ -2,7 +2,8 @@ terraform {
   required_providers {
     bytebase = {
       version = "0.0.3"
-      source  = "terraform.local/bytebase/bytebase"
+      # For local development, please use "terraform.local/bytebase/bytebase" instead
+      source = "registry.terraform.io/bytebase/bytebase"
     }
   }
 }

examples/instances/main.tf

@@ -2,7 +2,8 @@ terraform {
   required_providers {
     bytebase = {
       version = "0.0.3"
-      source  = "terraform.local/bytebase/bytebase"
+      # For local development, please use "terraform.local/bytebase/bytebase" instead
+      source = "registry.terraform.io/bytebase/bytebase"
     }
   }
 }

examples/main.tf

@@ -13,7 +13,9 @@ provider "bytebase" {
   # You need to replace the account and key with your Bytebase service account.
   service_account = "[email protected]"
   service_key     = "bbs_qHX6CswQ1nMMELSCc2lk"
-  url             = "https://bytebase.example.com"
+  # The Bytebase service URL. You can use the external URL in production.
+  # Check the docs about external URL: https://www.bytebase.com/docs/get-started/install/external-url
+  url = "https://bytebase.example.com"
 }
 
 locals {

examples/versions.tf

@@ -2,7 +2,8 @@ terraform {
   required_providers {
     bytebase = {
       version = "0.0.3"
-      source  = "terraform.local/bytebase/bytebase"
+      # For local development, please use "terraform.local/bytebase/bytebase" instead
+      source = "registry.terraform.io/bytebase/bytebase"
     }
   }
 }