Merge pull request #54 from hashicorp/cleanup

Change to doc generation

Author: paultyng

README.md

@@ -1,11 +1,7 @@
 Terraform `null` Provider
 =========================
 
-- Website: https://www.terraform.io
-- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
-- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
-
-<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
+See the documentation for this provider on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/null/latest/docs) for usage information.
 
 Maintainers
 -----------
@@ -34,14 +30,13 @@ $ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-null
 $ make build
 ```
 
-Using the provider
-----------------------
-## Fill in for each provider
 
 Developing the Provider
 ---------------------------
 
-If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
+If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.15+ is *required*).
+
+To generate the documentation, run `go generate` in the root of the codebase.
 
 To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
 

docs/data-sources/data_source.md

@@ -0,0 +1,58 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "null_data_source Data Source - terraform-provider-null"
+subcategory: ""
+description: |-
+  The null_data_source data source implements the standard data source lifecycle but does not
+  interact with any external APIs.
+  Historically, the null_data_source was typically used to construct intermediate values to re-use elsewhere in configuration. The
+  same can now be achieved using locals https://www.terraform.io/docs/language/values/locals.html.
+---
+
+# null_data_source
+
+The `null_data_source` data source implements the standard data source lifecycle but does not
+interact with any external APIs.
+
+Historically, the `null_data_source` was typically used to construct intermediate values to re-use elsewhere in configuration. The
+same can now be achieved using [locals](https://www.terraform.io/docs/language/values/locals.html).
+
+## Example Usage
+
+```terraform
+data "null_data_source" "values" {
+  inputs = {
+    all_server_ids = concat(aws_instance.green.*.id, aws_instance.blue.*.id)
+    all_server_ips = concat(aws_instance.green.*.private_ip, aws_instance.blue.*.private_ip)
+  }
+}
+
+resource "aws_elb" "main" {
+  # ...
+
+  instances = data.null_data_source.values.outputs["all_server_ids"]
+}
+
+output "all_server_ids" {
+  value = data.null_data_source.values.outputs["all_server_ids"]
+}
+
+output "all_server_ips" {
+  value = data.null_data_source.values.outputs["all_server_ips"]
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- **has_computed_default** (String) If set, its literal value will be stored and returned. If not, its value defaults to `"default"`. This argument exists primarily for testing and has little practical use.
+- **inputs** (Map of String) A map of arbitrary strings that is copied into the `outputs` attribute, and accessible directly for interpolation.
+
+### Read-Only
+
+- **id** (String, Deprecated) This attribute is only present for some legacy compatibility issues and should not be used. It will be removed in a future version.
+- **outputs** (Map of String) After the data source is "read", a copy of the `inputs` map.
+- **random** (String) A random value. This is primarily for testing and has little practical use; prefer the [hashicorp/random provider](https://registry.terraform.io/providers/hashicorp/random) for more practical random number use-cases.
+

docs/index.md

@@ -0,0 +1,23 @@
+---
+page_title: "Provider: Null"
+description: |-
+  The null provider provides no-op constructs that can be useful helpers in tricky cases.
+---
+
+# Null Provider
+
+The `null` provider is a rather-unusual provider that has constructs that
+intentionally do nothing. This may sound strange, and indeed these constructs
+do not need to be used in most cases, but they can be useful in various
+situations to help orchestrate tricky behavior or work around limitations.
+
+The documentation of each feature of this provider, accessible via the
+navigation, gives examples of situations where these constructs may prove
+useful.
+
+Usage of the `null` provider can make a Terraform configuration harder to
+understand. While it can be useful in certain cases, it should be applied with
+care and other solutions preferred when available.
+
+<!-- schema generated by tfplugindocs -->
+## Schema

docs/resources/resource.md

@@ -0,0 +1,63 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "null_resource Resource - terraform-provider-null"
+subcategory: ""
+description: |-
+  The null_resource resource implements the standard resource lifecycle but takes no further action.
+  The triggers argument allows specifying an arbitrary set of values that, when changed, will cause the resource to be replaced.
+---
+
+# null_resource
+
+The `null_resource` resource implements the standard resource lifecycle but takes no further action.
+
+The `triggers` argument allows specifying an arbitrary set of values that, when changed, will cause the resource to be replaced.
+
+## Example Usage
+
+```terraform
+resource "aws_instance" "cluster" {
+  count = 3
+
+  # ...
+}
+
+# The primary use-case for the null resource is as a do-nothing container for
+# arbitrary actions taken by a provisioner.
+#
+# In this example, three EC2 instances are created and then a null_resource instance
+# is used to gather data about all three and execute a single action that affects
+# them all. Due to the triggers map, the null_resource will be replaced each time
+# the instance ids change, and thus the remote-exec provisioner will be re-run.
+resource "null_resource" "cluster" {
+  # Changes to any instance of the cluster requires re-provisioning
+  triggers = {
+    cluster_instance_ids = join(",", aws_instance.cluster.*.id)
+  }
+
+  # Bootstrap script can run on any instance of the cluster
+  # So we just choose the first in this case
+  connection {
+    host = element(aws_instance.cluster.*.public_ip, 0)
+  }
+
+  provisioner "remote-exec" {
+    # Bootstrap script called with private_ip of each node in the clutser
+    inline = [
+      "bootstrap-cluster.sh ${join(" ", aws_instance.cluster.*.private_ip)}",
+    ]
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- **triggers** (Map of String) A map of arbitrary strings that, when changed, will force the null resource to be replaced, re-running any associated provisioners.
+
+### Read-Only
+
+- **id** (String) This is set to a random value at create time.
+

examples/data-sources/null_data_source/data-source.tf

@@ -0,0 +1,20 @@
+data "null_data_source" "values" {
+  inputs = {
+    all_server_ids = concat(aws_instance.green.*.id, aws_instance.blue.*.id)
+    all_server_ips = concat(aws_instance.green.*.private_ip, aws_instance.blue.*.private_ip)
+  }
+}
+
+resource "aws_elb" "main" {
+  # ...
+
+  instances = data.null_data_source.values.outputs["all_server_ids"]
+}
+
+output "all_server_ids" {
+  value = data.null_data_source.values.outputs["all_server_ids"]
+}
+
+output "all_server_ips" {
+  value = data.null_data_source.values.outputs["all_server_ips"]
+}

examples/resources/null_resource/resource.tf

@@ -0,0 +1,32 @@
+resource "aws_instance" "cluster" {
+  count = 3
+
+  # ...
+}
+
+# The primary use-case for the null resource is as a do-nothing container for
+# arbitrary actions taken by a provisioner.
+#
+# In this example, three EC2 instances are created and then a null_resource instance
+# is used to gather data about all three and execute a single action that affects
+# them all. Due to the triggers map, the null_resource will be replaced each time
+# the instance ids change, and thus the remote-exec provisioner will be re-run.
+resource "null_resource" "cluster" {
+  # Changes to any instance of the cluster requires re-provisioning
+  triggers = {
+    cluster_instance_ids = join(",", aws_instance.cluster.*.id)
+  }
+
+  # Bootstrap script can run on any instance of the cluster
+  # So we just choose the first in this case
+  connection {
+    host = element(aws_instance.cluster.*.public_ip, 0)
+  }
+
+  provisioner "remote-exec" {
+    # Bootstrap script called with private_ip of each node in the clutser
+    inline = [
+      "bootstrap-cluster.sh ${join(" ", aws_instance.cluster.*.private_ip)}",
+    ]
+  }
+}

go.mod

@@ -1,5 +1,8 @@
 module github.com/terraform-providers/terraform-provider-null
 
-require github.com/hashicorp/terraform-plugin-sdk/v2 v2.0.3
+require (
+	github.com/hashicorp/terraform-plugin-docs v0.4.0
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.4.2
+)
 
 go 1.15