Skip to content

Commit 8c686c1

Browse files
authored
Merge pull request #204 from dbt-labs/add-info-readme
Add info to README
2 parents c103ae1 + 5c22381 commit 8c686c1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ provider "dbtcloud" {
3636
// required
3737
account_id = ...
3838
token = "..."
39-
// optional
39+
// optional - defaults to the US Multi Tenant URL "https://cloud.getdbt.com/api"
4040
host_url = "..."
4141
}
4242
```
@@ -46,11 +46,12 @@ You can also set them via environment variables:
4646
`DBT_CLOUD_TOKEN` for the `token`.
4747
`DBT_CLOUD_HOST_URL` (Optional) for the `host_url`.
4848

49-
## Examples
49+
## Getting started and Examples
5050

51-
Check out the `examples/` folder for some usage options, these are intended to
52-
simply showcase what this module can do rather than be best practices for any
53-
given use case.
51+
The provider documentation is directly available [on the Terraform Registry](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs).
52+
53+
- Under [Guides](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/guides/1_getting_started), you will find a simple example of how to use the provider
54+
- Each resource ([example for jobs](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job)) has some usage examples and contains the list of parameters available
5455

5556
## Running Acceptance Tests
5657

@@ -61,4 +62,3 @@ own account
6162

6263
Thanks to Gary James [[GtheSheep](https://github.com/GtheSheep)], for all the effort put in creating this provider originally
6364
and for being a great dbt community member!
64-

0 commit comments

Comments
 (0)