add instructions in doc index (#33)

tidbcloud · Nov 23, 2022 · 1eaf7fc · 1eaf7fc
1 parent a9e8fbf
commit 1eaf7fc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -13,8 +13,6 @@ description: |-
 ## Example Usage
 
 ```terraform
-# We provide a full example in README https://github.com/tidbcloud/terraform-provider-tidbcloud#using-the-provider
-
 terraform {
   required_providers {
     tidbcloud = {
@@ -25,6 +23,11 @@ terraform {
   required_version = ">= 1.0.0"
 }
 
+# Instructions for getting an API Key
+# https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management
+# You can also pass the keys through environment variables:
+# export TIDBCLOUD_PUBLIC_KEY = "fake_public_key"
+# export TIDBCLOUD_PRIVATE_KEY = "fake_private_key"
 provider "tidbcloud" {
   public_key  = "fake_public_key"
   private_key = "fake_private_key"

diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,5 +1,3 @@
-# We provide a full example in README https://github.com/tidbcloud/terraform-provider-tidbcloud#using-the-provider
-
 terraform {
   required_providers {
     tidbcloud = {
@@ -10,7 +8,12 @@ terraform {
   required_version = ">= 1.0.0"
 }
 
+# Instructions for getting an API Key
+# https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management
+# You can also pass the keys through environment variables:
+# export TIDBCLOUD_PUBLIC_KEY = "fake_public_key"
+# export TIDBCLOUD_PRIVATE_KEY = "fake_private_key"
 provider "tidbcloud" {
   public_key  = "fake_public_key"
   private_key = "fake_private_key"
-}
+}