Skip to content

Commit

Permalink
Merge branch 'current' into nfiann-faq&gear
Browse files Browse the repository at this point in the history
  • Loading branch information
nataliefiann authored Nov 18, 2024
2 parents 181c0ed + 3a24380 commit 4f93533
Show file tree
Hide file tree
Showing 22 changed files with 74 additions and 47 deletions.
4 changes: 3 additions & 1 deletion website/docs/docs/build/data-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ having total_amount < 0

</File>

The name of this test is the name of the file: `assert_total_payment_amount_is_positive`.
The name of this test is the name of the file: `assert_total_payment_amount_is_positive`.

Note, you won't need to include semicolons (;) at the end of the SQL statement in your singular test files as it can cause your test to fail.

To add a description to a singular test in your project, add a `.yml` file to your `tests` directory, for example, `tests/schema.yml` with the following content:

Expand Down
5 changes: 4 additions & 1 deletion website/docs/docs/build/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ Every job runs in a specific, deployment environment, and by default, a job will
**Overriding environment variables at the personal level**


You can also set a personal value override for an environment variable when you develop in the dbt-integrated developer environment (IDE). By default, dbt Cloud uses environment variable values set in the project's development environment. To see and override these values, click the gear icon in the top right. Under "Your Profile," click **Credentials** and select your project. Click **Edit** and make any changes in "Environment Variables."
You can also set a personal value override for an environment variable when you develop in the dbt-integrated developer environment (IDE). By default, dbt Cloud uses environment variable values set in the project's development environment. To see and override these values, from dbt Cloud:
- Click on your account name in the left side menu and select **Account settings**.
- Under the **Your profile** section, click **Credentials** and then select your project.
- Scroll to the **Environment variables** section and click **Edit** to make the necessary changes.

<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/Environment Variables/personal-override.gif" title="Navigating to environment variables personal override settings"/>

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ dbt Labs may institute use limits if reasonable use is exceeded. Additional feat

## Managing usage

From anywhere in the dbt Cloud account, click the **gear icon** and click **Account settings**. The **Billing** option will be on the left side menu under the **Account Settings** heading. Here, you can view individual available plans and the features provided for each.
From dbt Cloud, click on your account name in the left side menu and select **Account settings**. The **Billing** option will be on the left side menu under the **Settings** heading. Here, you can view individual available plans and the features provided for each.

### Usage notifications

Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/cloud/configure-cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ With your repo recloned, you can add, edit, and sync files with your repo.

To set environment variables in the dbt Cloud CLI for your dbt project:

1. Select the gear icon on the upper right of the page.
2. Then select **Profile Settings**, then **Credentials**.
3. Click on your project and scroll to the **Environment Variables** section.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. Under the **Your profile** section, select **Credentials**.
3. Click on your project and scroll to the **Environment variables** section.
4. Click **Edit** on the lower right and then set the user-level environment variables.

## Use the dbt Cloud CLI
Expand Down
28 changes: 16 additions & 12 deletions website/docs/docs/cloud/git/connect-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,21 @@ Connecting your GitHub account to dbt Cloud provides convenience and another lay
You can connect your dbt Cloud account to GitHub by installing the dbt Cloud application in your GitHub organization and providing access to the appropriate repositories.
To connect your dbt Cloud account to your GitHub account:

1. Navigate to **Your Profile** settings by clicking the gear icon in the top right.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.

2. Select **Linked Accounts** from the left menu.
2. Select **Personal profile** under the **Your profile** section.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-github/github-connect.gif" title="Navigated to Linked Accounts under your profile"/>
3. Scroll down to **Linked accounts**.

3. In the **Linked Accounts** section, set up your GitHub account connection to dbt Cloud by clicking **Link** to the right of GitHub. This redirects you to your account on GitHub where you will be asked to install and configure the dbt Cloud application.
<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-github/github-connect-1.png" title="Navigated to Linked Accounts under your profile"/>

4. Select the GitHub organization and repositories dbt Cloud should access.
4. In the **Linked accounts** section, set up your GitHub account connection to dbt Cloud by clicking **Link** to the right of GitHub. This redirects you to your account on GitHub where you will be asked to install and configure the dbt Cloud application.

5. Select the GitHub organization and repositories dbt Cloud should access.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-github/github-app-install.png" title="Installing the dbt Cloud application into a GitHub organization"/>

5. Assign the dbt Cloud GitHub App the following permissions:
6. Assign the dbt Cloud GitHub App the following permissions:
- Read access to metadata
- Read and write access to Checks
- Read and write access to Commit statuses
Expand All @@ -46,8 +48,8 @@ To connect your dbt Cloud account to your GitHub account:
- Read and write access to Webhooks
- Read and write access to Workflows

6. Once you grant access to the app, you will be redirected back to dbt Cloud and shown a linked account success state. You are now personally authenticated.
7. Ask your team members to individually authenticate by connecting their [personal GitHub profiles](#authenticate-your-personal-github-account).
7. Once you grant access to the app, you will be redirected back to dbt Cloud and shown a linked account success state. You are now personally authenticated.
8. Ask your team members to individually authenticate by connecting their [personal GitHub profiles](#authenticate-your-personal-github-account).

## Limiting repository access in GitHub
If you are your GitHub organization owner, you can also configure the dbt Cloud GitHub application to have access to only select repositories. This configuration must be done in GitHub, but we provide an easy link in dbt Cloud to start this process.
Expand All @@ -67,14 +69,16 @@ After the dbt Cloud administrator [sets up a connection](/docs/cloud/git/connect

To connect a personal GitHub account:

1. Navigate to **Your Profile** settings by clicking the gear icon in the top right.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.

2. Select **Personal profile** under the **Your profile** section.

2. Select **Linked Accounts** in the left menu. If your GitHub account is not connected, you’ll see "No connected account".
3. Scroll down to **Linked accounts**. If your GitHub account is not connected, you’ll see "No connected account".

3. Select **Link** to begin the setup process. You’ll be redirected to GitHub, and asked to authorize dbt Cloud in a grant screen.
4. Select **Link** to begin the setup process. You’ll be redirected to GitHub, and asked to authorize dbt Cloud in a grant screen.
<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-github/github-auth.png" title="Authorizing the dbt Cloud app for developers"/>

4. Once you approve authorization, you will be redirected to dbt Cloud, and you should now see your connected account.
5. Once you approve authorization, you will be redirected to dbt Cloud, and you should now see your connected account.

You can now use the dbt Cloud IDE or dbt Cloud CLI.

Expand Down
17 changes: 12 additions & 5 deletions website/docs/docs/cloud/git/connect-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ The steps to integrate GitLab in dbt Cloud depend on your plan. If you are on:
## For dbt Cloud Developer and Team tiers

To connect your GitLab account:
1. Navigate to Your Profile settings by clicking the gear icon in the top right.
2. Select **Linked Accounts** in the left menu.
3. Click **Link** to the right of your GitLab account.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. Select **Personal profile** under the **Your profile** section.
3. Scroll down to **Linked accounts**.
4. Click **Link** to the right of your GitLab account.

<Lightbox src="/img/docs/dbt-cloud/connecting-gitlab/gitlab redirect.gif" title="Link your GitLab" />
<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-github/github-connect.png" title="The Personal profile settings with the Linked Accounts section of the user profile"/>

When you click **Link**, you will be redirected to GitLab and prompted to sign into your account. GitLab will then ask for your explicit authorization:

Expand Down Expand Up @@ -99,7 +100,13 @@ Once you've accepted, you should be redirected back to dbt Cloud, and your integ
### Personally authenticating with GitLab
dbt Cloud developers on the Enterprise plan must each connect their GitLab profiles to dbt Cloud, as every developer's read / write access for the dbt repo is checked in the dbt Cloud IDE or dbt Cloud CLI.

To connect a personal GitLab account, dbt Cloud developers should navigate to Your Profile settings by clicking the gear icon in the top right, then select **Linked Accounts** in the left menu.
To connect a personal GitLab account:

1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.

2. Select **Personal profile** under the **Your profile** section.

3. Scroll down to **Linked accounts**.

If your GitLab account is not connected, you’ll see "No connected account". Select **Link** to begin the setup process. You’ll be redirected to GitLab, and asked to authorize dbt Cloud in a grant screen.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/cloud/git/import-a-project-by-git-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ You must use the `git@...` or `ssh:..`. version of your git URL, not the `https:

After importing a project by Git URL, dbt Cloud will generate a Deploy Key for your repository. To find the deploy key in dbt Cloud:

1. Click the gear icon in the upper right-hand corner.
2. Click **Account Settings** --> **Projects** and select a project.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. Go to **Projects** and select a project.
3. Click the **Repository** link to the repository details page.
4. Copy the key under the **Deploy Key** section.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/cloud/manage-access/audit-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The dbt Cloud audit log stores all the events that occurred in your organization

## Accessing the audit log

To access the audit log, click the gear icon in the top right, then click **Audit Log**.
To access the audit log, click on your account name in the left side menu and select **Account settings**.

<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/audit-log-menu.png" width="30%" title="Audit log menu"/>

Expand Down
10 changes: 5 additions & 5 deletions website/docs/docs/cloud/manage-access/cloud-seats-and-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following tabs detail steps on how to modify your user license count:

If you're on an Enterprise plan and have the correct [permissions](/docs/cloud/manage-access/enterprise-permissions), you can add or remove licenses by adjusting your user seat count. Note, an IT license does not count toward seat usage.

- To remove a user, go to **Account Settings** and select **Users**.
- To remove a user, click on your account name in the left side menu, click **Account settings** and select **Users**.
- Select the user you want to remove, click **Edit**, and then **Delete**.
- This action cannot be undone. However, you can re-invite the user with the same info if you deleted the user in error.<br />

Expand All @@ -64,7 +64,7 @@ If you're on an Enterprise plan and have the correct [permissions](/docs/cloud/m

If you're on a Team plan and have the correct [permissions](/docs/cloud/manage-access/self-service-permissions), you can add or remove developers. You'll need to make two changes:

- Adjust your developer user seat count, which manages the users invited to your dbt Cloud project. AND
- Adjust your developer user seat count, which manages the users invited to your dbt Cloud project.
- Adjust your developer billing seat count, which manages the number of billable seats.


Expand All @@ -75,7 +75,7 @@ You can add or remove developers by increasing or decreasing the number of users

To add a user in dbt Cloud, you must be an account owner or have admin privileges.

1. From dbt Cloud, click the gear icon at the top right and select **Account Settings**.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.

<Lightbox src="/img/docs/dbt-cloud/Navigate To Account Settings.png" width="75%" title="Navigate to Account Settings" />

Expand All @@ -95,11 +95,11 @@ Great work! After completing those these steps, your dbt Cloud user count and bi

To delete a user in dbt Cloud, you must be an account owner or have admin privileges. If the user has a `developer` license type, this will open up their seat for another user or allow the admins to lower the total number of seats.

1. From dbt Cloud, click the gear icon at the top right and select **Account Settings**.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.

<Lightbox src="/img/docs/dbt-cloud/Navigate To Account Settings.png" width="85%" title="Navigate to Account Settings" />

2. In **Account Settings** and select **Users**.
2. In **Account Settings**, select **Users**.
3. Select the user you want to delete, then click **Edit**.
4. Click **Delete** in the bottom left. Click **Confirm Delete** to immediately delete the user without additional password prompts. This action cannot be undone. However, you can re-invite the user with the same information if the deletion was made in error.

Expand Down
13 changes: 7 additions & 6 deletions website/docs/docs/cloud/manage-access/set-up-databricks-oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,20 @@ You can use the following table to set up the redirect URLs for your application
### Configure the Connection in dbt Cloud (dbt Cloud project admin)

Now that you have an OAuth app set up in Databricks, you'll need to add the client ID and secret to dbt Cloud. To do so:
- go to Settings by clicking the gear in the top right.
- on the left, select **Projects** under **Account Settings**
- choose your project from the list
- select **Connection** to edit the connection details
- add the `OAuth Client ID` and `OAuth Client Secret` from the Databricks OAuth app under the **Optional Settings** section
- From dbt Cloud, click on your account name in the left side menu and select **Account settings**
- Select **Projects** from the menu
- Choose your project from the list
- Select **Connection** to edit the connection details
- Add the `OAuth Client ID` and `OAuth Client Secret` from the Databricks OAuth app under the **Optional Settings** section

<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/dbt-cloud-enterprise/DBX-auth/dbt-databricks-oauth.png" title="Adding Databricks OAuth application client ID and secret to dbt Cloud" />

### Authenticating to Databricks (dbt Cloud IDE developer)

Once the Databricks connection via OAuth is set up for a dbt Cloud project, each dbt Cloud user will need to authenticate with Databricks in order to use the IDE. To do so:

- Click the gear icon at the top right and select **Profile settings**.
- From dbt Cloud, click on your account name in the left side menu and select **Account settings**
- Select **Profile settings**.
- Select **Credentials**.
- Choose your project from the list
- Select `OAuth` as the authentication method, and click **Save**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,9 @@ To complete setup, follow the steps below in the dbt Cloud application.

### Supplying credentials

25. Click the gear icon at the top right and select **Profile settings**. To the left, select **Single Sign On** under **Account Settings**.
26. Click the **Edit** button and supply the following SSO details:
25. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
26. Click **Single sign-on** from the menu.
27. Click the **Edit** button and supply the following SSO details:

| Field | Value |
| ----- | ----- |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/dbt-cloud-apis/service-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can assign as many permission sets as needed to one token. For more on permi

You can generate service tokens if you have a Developer [license](/docs/cloud/manage-access/seats-and-users) and account admin [permissions](/docs/cloud/manage-access/about-user-access#permission-sets). To create a service token in dbt Cloud, follow these steps:

1. Open the **Account Settings** page by clicking the gear icon on the right-hand side.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. On the left sidebar, click on **Service Tokens**.
3. Click the **+ New Token** button to generate a new token.
4. Once the token is generated, you won't be able to view this token again so make sure to save it somewhere safe.
Expand Down
3 changes: 2 additions & 1 deletion website/docs/docs/dbt-versions/experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ You can access experimental features to preview beta features that haven’t yet

To enable or disable experimental features:

1. Navigate to **Profile settings** by clicking the gear icon in the top right.
1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**
2. Go to **Personal profile** under the **Your profile** header.
2. Find Experimental features at the bottom of Your Profile page.
3. Click **Beta** to toggle the features on or off as shown in the following image.
![Experimental features](/img/docs/dbt-versions/experimental-feats.png)
Expand Down
6 changes: 5 additions & 1 deletion website/docs/docs/deploy/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ To view a resource, its metadata, and what commands are needed, refer to [genera

The following steps are for legacy dbt Docs only. For the current documentation experience, see [dbt Explorer](/docs/collaborate/explore-projects).

While running any job can produce artifacts, you should only associate one production job with a given project to produce the project's artifacts. You can designate this connection on the **Project details** page. To access this page, click the gear icon in the upper right, select **Account Settings**, select your project, and click **Edit** in the lower right. Under **Artifacts**, select the jobs you want to produce documentation and source freshness artifacts for.
While running any job can produce artifacts, you should only associate one production job with a given project to produce the project's artifacts. You can designate this connection on the **Project details** page. To access this page:

1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. Select your project, and click **Edit** in the lower right.
3. Under **Artifacts**, select the jobs you want to produce documentation and source freshness artifacts for.

<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/project-level-artifact-updated.png" width="70%" title="Configuring Artifacts"/>

Expand Down
6 changes: 5 additions & 1 deletion website/docs/faqs/Git/managed-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ id: managed-repo

dbt Labs can send your managed repository through a ZIP file in its current state for you to push up to a git provider. After that, you'd just need to switch over to the [repo in your project](/docs/cloud/git/import-a-project-by-git-url) to point to the new repository.

When you're ready to do this, [contact the dbt Labs Support team](mailto:[email protected]) with your request and your managed repo URL, which you can find by navigating to your project setting. To find project settings, click the gear icon in the upper right, select **Account settings**, click **Projects**, and then select your project. Under **Repository** in the project details page, you can find your managed repo URL.
When you're ready to do this, [contact the dbt Labs Support team](mailto:[email protected]) with your request and your managed repo URL, which you can find by navigating to your project setting. To find project settings:

1. From dbt Cloud, click on your account name in the left side menu and select **Account settings**.
2. Click **Projects**, and then select your project.
3. Under **Repository** in the project details page, you can find your managed repo URL.
Loading

0 comments on commit 4f93533

Please sign in to comment.