Skip to content

Commit

Permalink
Merge pull request #706 from dbt-labs/repo-sync
Browse files Browse the repository at this point in the history
REPO SYNC - Public to Private
  • Loading branch information
john-rock authored Jul 30, 2024
2 parents 24f4e02 + ca2605f commit edb77e4
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 15 deletions.
6 changes: 3 additions & 3 deletions website/docs/docs/build/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ models:

The default documentation experience in dbt Cloud is [dbt Explorer](/docs/collaborate/explore-projects), available on [Team or Enterprise plans](https://www.getdbt.com/pricing/). Use dbt Explorer to view your project's resources (such as models, tests, and metrics), its [metadata](/docs/collaborate/explore-projects#generate-metadata), and their lineage to gain a better understanding of its latest production state.

dbt Cloud developer and dbt Core users can use [dbt Docs](/docs/collaborate/build-and-view-your-docs#dbt-docs), which generates basic documentation, but it doesn't offer the same speed, metadata, or visibility as dbt Explorer.
dbt Cloud developer and dbt Core users can use [dbt Docs](/docs/collaborate/build-and-view-your-docs#dbt-docs), which generates basic documentation, but doesn't offer the same speed, metadata, or visibility as dbt Explorer.

Generate documentation for you project by following these steps:
Generate documentation for your project by following these steps:

1. Run `dbt docs generate` — this command tells dbt to compile relevant information about your dbt project and warehouse into `manifest.json` and `catalog.json` files, respectively.
2. Ensure that you have created the models with `dbt run` to view the documentation for all columns, not just those described in your project.
2. Ensure you've created the models with `dbt run` to view the documentation for all columns, not just those described in your project.
3. Run `dbt docs serve` if you're developing locally to use these `.json` files to populate a local website.

To view a resource, its metadata, and what commands are needed in dbt Explorer, refer to [generate metadata](/docs/collaborate/explore-projects#generate-metadata) for more details.
Expand Down
2 changes: 0 additions & 2 deletions website/docs/docs/collaborate/build-and-view-your-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ For a richer and more interactive experience, try out [dbt Explorer](/docs/coll

To generate documentation in the dbt Cloud IDE, run the `dbt docs generate` command in the **Command Bar** in the dbt Cloud IDE. This command will generate the documentation for your dbt project as it exists in development in your IDE session.

After generating your documentation, you can click **Explore** in the navigation. This will take you to <a href="https://docs.getdbt.com/docs/collaborate/explore-projects">dbt Explorer</a>, where you can view your project's resources and their lineage.

After running `dbt docs generate` in the dbt Cloud IDE, click the icon above the file tree, to see the latest version of your documentation rendered in a new browser window.

### View documentation
Expand Down
32 changes: 22 additions & 10 deletions website/docs/faqs/Git/github-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,41 @@ sidebar_label: "GitHub and dbt Cloud permissions error"

If you see the error `This account needs to accept the latest permissions for the dbt Cloud GitHub App` in dbt Cloud &mdash; this usually occurs when the permissions for the dbt Cloud GitHub App are out of date.

To solve this issue, you'll need to update the permissions for the dbt Cloud GitHub App in your GitHub account. Here's a couple of ways you can do it:
To solve this issue, you'll need to update the permissions for the dbt Cloud GitHub App in your GitHub account. This FAQ shares a couple of ways you can do it.

#### Update permissions
## Update permissions

A Github organization admin will need to update the permissions in GitHub for the dbt Cloud GitHub App. If you're not the admin, reach out to your organization admin to request this. Alternatively, try [disconecting your GitHub account](#disconect-github) in dbt Cloud.
A GitHub organization admin will need to update the permissions in GitHub for the dbt Cloud GitHub App. If you're not the admin, reach out to your organization admin to request this.

1. Navigate to your GitHub account. Click on the top right profile icon and then **Settings** (or personal if using a non-organization account).

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-settings.jpg" width="50%" title="Navigate to your GitHub account to configure your settings." />

2. Then go to **Integrations** and then select **Applications** to identify any necessary permission changes. Note that a GitHub repository admin may not see the same permission request.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-applications.jpg" width="80%" title="Navigate to Application settings to identify permission changes." />

3. Click on **Review request** and then click on the **Accept new permissions** button on the next page.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/github-review-request.jpg" width="80%" title="Grant access to the dbt Cloud app by accepting the new permissions." />

1. Go directly to GitHub to determine if any updated permissions are required.
2. In GitHub, go to your organization **Settings** (or personal if using a non-organization account).
3. Then navigate to **Applications** to identify any necessary permission changes.
For more info on GitHub permissions, refer to [access permissions](https://docs.github.com/en/get-started/learning-about-github/access-permissions-on-github).

#### Disconnect GitHub
Alternatively, try [disconecting your GitHub account](#disconect-github) in dbt Cloud, detailed in the following section.

## Disconnect GitHub

Disconnect the GitHub and dbt Cloud integration in dbt Cloud.

1. In dbt Cloud, go to **Account Settings**.
2. In **Projects**, select the project that's experiencing the issue.
2. In **Projects**, select the project experiencing the issue.
3. Click the repository link under **Repository**.
4. In the **Repository details** page, click **Edit**.
5. Click **Disconnect** to remove the GitHub integration.
6. Go back to your **Project details** page and reconnect your repository by clicking the **Configure Repository** link.
6. Return to your **Project details** page and reconnect your repository by clicking the **Configure Repository** link.
7. Configure your repository and click **Save**

<Lightbox src="/img/repository-details-faq.jpg" title="Disconnect your GitHub connection in the 'Repository details' page."/>
<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/repository-details-faq.jpg" title="Disconnect your GitHub connection in the 'Repository details' page."/>

## Support
If you've tried these workarounds and are still experiencing this behavior &mdash; reach out to the [dbt Support](mailto:[email protected]) team and we'll be happy to help!
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: " About properties.yml context"
sidebar_label: "properties.yml context"
id: "dbt-properties-yml-context"
description: "The context methods and variables available when configuring resources in a properties.yml file."
---

The following context methods and variables are available when configuring
resources in a `properties.yml` file.

**Available context methods:**
- [env_var](/reference/dbt-jinja-functions/env_var)
- [var](/reference/dbt-jinja-functions/var)

**Available context variables:**
- [target](/reference/dbt-jinja-functions/target)
- [builtins](/reference/dbt-jinja-functions/builtins)
- [dbt_version](/reference/dbt-jinja-functions/dbt_version)

### Example configuration

<File name='properties.yml'>

```yml
# Configure this model to be materialized as a view
# in development and a table in production/CI contexts

models:
- name: dim_customers
config:
materialized: "{{ 'view' if target.name == 'dev' else 'table' }}"
```
</File>
2 changes: 2 additions & 0 deletions website/docs/reference/node-selection/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ For example, given a model with the following configurations:
materialized = 'incremental',
unique_key = ['column_a', 'column_b'],
grants = {'select': ['reporter', 'analysts']},
meta = {"contains_pii": true},
transient = true
) }}

Expand All @@ -144,6 +145,7 @@ select ...
dbt ls -s config.materialized:incremental
dbt ls -s config.unique_key:column_a
dbt ls -s config.grants.select:reporter
dbt ls -s config.meta.contains_pii:true
dbt ls -s config.transient:true
```
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit edb77e4

Please sign in to comment.