Explore documentation options for resources in terraform provider

[dylanirlbeck]

Going forward, we should be thinking about how to document the uses for each resource in our terraform provider. I've found that at times the examples can be a bit ambiguous, especially since there are elements that are either computed or optional and don't show up in the config file.

We should explore options for documenting our Terraform provider in the same way we document our API's. This is of particular importance since our customers will be interfacing with Terraform more than they do our API's.

[drbild]

Agreed.

The "official" terraform providers keep the docs in the repo. See the AWS provider docs.

We should be able to do the same and host the generated documentation at docs.xaptum.com/terraform