Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecating user API key from docs #6358

Merged
merged 10 commits into from
Oct 24, 2024
Merged

Deprecating user API key from docs #6358

merged 10 commits into from
Oct 24, 2024

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Oct 24, 2024

What are you changing in this pull request and why?

User API keys have been deprecated. Removing implementation instructions and references in the docs. Replacing with Account-scoped PATs.

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@matthewshaver matthewshaver requested a review from a team as a code owner October 24, 2024 18:22
Copy link

vercel bot commented Oct 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Oct 24, 2024 11:04pm

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Oct 24, 2024
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great Matt! Just some small suggestions on acronym vs spelling it out and some wording suggestions.


:::
It's recommended that you rotate your PATs at regular intervals for security purposes. To rotate your PATs, create a new token and, once it's in place, delete the old token.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It's recommended that you rotate your PATs at regular intervals for security purposes. To rotate your PATs, create a new token and, once it's in place, delete the old token.
It's recommended that you regularly rotate your PATs to maintain robust security. To rotate your PATs, create a new token and, once it's in place, delete the old token.

website/docs/docs/dbt-cloud-apis/authentication.md Outdated Show resolved Hide resolved

:::info New
Copy the token prior to closing the window. _It will not be available after and you will have to create a new token if you lose it._
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be step #4?


Each dbt Cloud user with a [Developer license](https://docs.getdbt.com/docs/cloud/manage-access/seats-and-users) can create a new personal access token (PAT) to access the dbt Cloud API and dbt Cloud CLI. This token can execute queries against the dbt Cloud API on the user's behalf. To access dbt Cloud APIs and resources on behalf of the _account_, we recommend using service Tokens instead. Learn more about [which token type you should use](/docs/dbt-cloud-apis/authentication#which-token-type-should-you-use) to understand the token differences.
To delete a token:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be easier for folks to find if we elevate it to an L2. Whatever you decide for creating a PAT, you should do here identifying the acronym in the header or 1st paragraph.

Suggested change
To delete a token:
## Delete a personal access token (PAT)
If you're rotating your tokens, make sure to create a new token before deleting the old one.
To delete a PAT:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We define (PAT) in the headers above, it might be a little overkill here. Makes the link simpler to leave it off

website/docs/docs/dbt-cloud-apis/user-tokens.md Outdated Show resolved Hide resolved
website/docs/docs/dbt-cloud-apis/user-tokens.md Outdated Show resolved Hide resolved
matthewshaver and others added 2 commits October 24, 2024 16:38
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
matthewshaver and others added 3 commits October 24, 2024 16:43
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@matthewshaver matthewshaver merged commit fe5fe97 into current Oct 24, 2024
11 of 12 checks passed
@matthewshaver matthewshaver deleted the remove-token branch October 24, 2024 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants