pre release changes

.github/workflows/test.yml

@@ -44,6 +44,11 @@ jobs:
         run: |
           git diff --compact-summary --exit-code || \
             (echo; echo "Unexpected difference in directories after code generation. Run 'go generate ./...' command and commit."; exit 1)
+      - name: Check generated docs
+        run: |
+          go install "github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs"
+          make docs
+          git diff --exit-code
 
   # Run acceptance tests in a matrix with Terraform CLI versions
   test:

GNUmakefile

@@ -10,3 +10,9 @@ testacc:
 .PHONY: local-build
 local-build:
 	go install .
+
+# Generate docs
+.PHONY: docs
+docs:
+	@which tfplugindocs &>/dev/null || (echo "install tfplugindocs (https://github.com/hashicorp/terraform-plugin-docs)"; exit 1)
+	tfplugindocs generate .

README.md

@@ -4,40 +4,36 @@ This is the [Terraform](https://www.terraform.io/) provider for the [Netdata Clo
 
 This provider allows you to install and manage Netdata Cloud resources using Terraform.
 
-
 ## Contents
 
 * [Requirements](#requirements)
 * [Getting Started](#getting-started)
 
 ## Requirements
 
-- [Terraform](https://www.terraform.io/downloads.html) v1.1.0 or later
-- [Go](https://golang.org/doc/install) v1.20 or later (to build the provider plugin)
+* [Terraform](https://www.terraform.io/downloads.html) v1.1.0 or later
+* [Go](https://golang.org/doc/install) v1.20 or later (to build the provider plugin)
 
 ## Getting Started
 
 * from terraform registry
 
-TODO
-
 * from source code
 
-	* setup your [CLI configuration](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers)
+    * setup your [CLI configuration](https://developer.hashicorp.com/terraform/cli/config/config-file#development-overrides-for-provider-developers)
 
-	```console
-	$ cat ~/.terraformrc
-	provider_installation {
-  		dev_overrides {
-		    # TODO: Update this string with the published name of your provider
-  		    "netdata.cloud/todo/netdata" = "<your GOBIN directory>"
-  		}
-  		direct {}
-	}
-	```
+    ```console
+    $ cat ~/.terraformrc
+    provider_installation {
+        dev_overrides {
+        "netdata/netdata" = "<your GOBIN directory>"
+        }
+        direct {}
+    }
+    ```
 
-	* build the provider
+    * build the provider
 
-	```console
-	$ make local-build
-	```
+    ```console
+    $ make local-build
+    ```

examples/complete/main.tf

@@ -1,8 +1,7 @@
 terraform {
   required_providers {
     netdata = {
-      # TODO: Update this string with the published name of your provider.
-      source = "netdata.cloud/todo/netdata"
+      source = "netdata/netdata"
     }
   }
   required_version = ">= 1.1.0"

main.go

@@ -20,8 +20,7 @@ func main() {
 	flag.Parse()
 
 	opts := providerserver.ServeOpts{
-		// TODO: Update this string with the published name of your provider.
-		Address: "netdata.cloud/todo/netdata",
+		Address: "registry.terraform.io/netdata/netdata",
 		Debug:   debug,
 	}