Skip to content

Commit

Permalink
Adding lifecycle pills to API docs (#5689)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Adding `team` and `enterprise` lifecycle pills to API token and overview
docs to clear confusion and reduce support comms.

See this thread
https://dbt-labs.slack.com/archives/C02SRNY2EQ4/p1718977586944139

## 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)
-->
- [ ] 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.
- [ ] 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).
- [ ] 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):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages

Co-authored-by: Ly Nguyen <[email protected]>
  • Loading branch information
matthewshaver and nghi-ly authored Jun 24, 2024
1 parent 763b6ca commit 73880c9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
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 @@ -6,7 +6,7 @@ pagination_next: "docs/dbt-cloud-apis/user-tokens"
pagination_prev: null
---

## Overview
# APIs overview <Lifecycle status="team,enterprise"/>

Accounts on the _Team_ and _Enterprise_ plans can query the dbt Cloud APIs.

Expand Down
3 changes: 3 additions & 0 deletions website/docs/docs/dbt-cloud-apis/service-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: "Service account tokens"
id: "service-tokens"
description: "Service account tokens help you define permissions for securing access to your dbt Cloud account and its projects."
---

# Service account tokens <Lifecycle status="team,enterprise"/>

:::info Important service account token update

If you have service tokens created on or before July 18, 2023, please read [this important update](/docs/dbt-cloud-apis/service-tokens#service-token-update).
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/dbt-cloud-apis/user-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ id: "user-tokens"
pagination_next: "docs/dbt-cloud-apis/service-tokens"
---

# User tokens <Lifecycle status="team,enterprise"/>

:::note Announcement

The [user API tokens](#user-tokens) are being replaced by [account-scoped personal access tokens(PATs)](#account-scoped-personal-access-tokens). We recommend rotating your existing user tokens with PATs. There are no deprecation plans for user API tokens at this time; we will give ample notice when that timeline has been determined.
Expand Down

0 comments on commit 73880c9

Please sign in to comment.