Skip to content

Commit

Permalink
Add info about the Terraform provider (#5728)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?
<!---
Describe your changes and why you're making them. If related to an open 
issue or a pull request on dbt Core, then link to them here! 

To learn more about the writing conventions used in the dbt Labs docs,
see the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md).
-->
Fixes #4210 , adding information about the Terraform provider in the
docs.

For now, this info is mostly about adding links to the provider and
existing documentation on the Terraform registry.

## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [x] Run link testing locally with `npm run build` to update the links
that point to deleted pages

Main change:

![image](https://github.com/dbt-labs/docs.getdbt.com/assets/8754100/ebc9a4ea-a934-4857-bdc5-7227b28fb2a8)

---------

Co-authored-by: Mirna Wong <[email protected]>
  • Loading branch information
b-per and mirnawong1 authored Aug 2, 2024
1 parent 608e24b commit 2299540
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions website/docs/docs/dbt-cloud-apis/admin-cloud-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The dbt Cloud Administrative API is enabled by default for [Team and Enterprise

dbt Cloud currently supports two versions of the Administrative API: v2 and v3. In general, v3 is the recommended version to use, but we don't yet have all our v2 routes upgraded to v3. We're currently working on this. If you can't find something in our v3 docs, check out the shorter list of v2 endpoints because you might find it there.

Many endpoints of the Administrative API can also be called through the [dbt Cloud Terraform provider](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest). The built-in documentation on the Terraform registry contains [a guide on how to get started with the provider](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/guides/1_getting_started) as well as [a page showing all the Terraform resources available](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/guides/99_list_resources) to configure.

<div className="grid--2-col">

<Card
Expand All @@ -33,4 +35,18 @@ link="/dbt-cloud/api-v2"
link="/dbt-cloud/api-v3"
icon="pencil-paper"/>

<div className="card-container">
<Card
title="dbt Cloud Terraform provider"
link="https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest"
body="The Terraform provider maintained by dbt Labs which can be used to manage a dbt Cloud account."
icon="pencil-paper"/>
<a href="https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest"
className="external-link"
target="_blank"
rel="noopener noreferrer">
<Icon name='fa-external-link' />
</a>
</div>

</div>
2 changes: 1 addition & 1 deletion website/docs/docs/dbt-cloud-apis/apis-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Accounts on the _Team_ and _Enterprise_ plans can query the dbt Cloud APIs.

dbt Cloud provides the following APIs:

- The [dbt Cloud Administrative API](/docs/dbt-cloud-apis/admin-cloud-api) can be used to administrate a dbt Cloud account.
- The [dbt Cloud Administrative API](/docs/dbt-cloud-apis/admin-cloud-api) can be used to administrate a dbt Cloud account. It can be called manually or with [the dbt Cloud Terraform provider](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest).
- The [dbt Cloud Discovery API](/docs/dbt-cloud-apis/discovery-api) can be used to fetch metadata related to the state and health of your dbt project.
- The [dbt Semantic Layer APIs](/docs/dbt-cloud-apis/sl-api-overview) provides multiple API options which allow you to query your metrics defined in the dbt Semantic Layer.

Expand Down

0 comments on commit 2299540

Please sign in to comment.