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

Updating notices across docs #4722

Merged
merged 28 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a3e8e2a
Updating notices across docs
matthewshaver Jan 8, 2024
3244267
Merge branch 'current' into notices
matthewshaver Jan 8, 2024
5da5893
Merge branch 'current' into notices
mirnawong1 Jan 9, 2024
e73a361
Update website/snippets/_cloud-environments-info.md
matthewshaver Jan 9, 2024
070e549
Update website/snippets/_cloud-environments-info.md
matthewshaver Jan 9, 2024
83ac67b
Update website/snippets/_cloud-environments-info.md
matthewshaver Jan 9, 2024
121c3c7
Update website/docs/reference/project-configs/require-dbt-version.md
matthewshaver Jan 9, 2024
c042f07
Update website/docs/guides/how-to-use-databricks-workflows-to-run-dbt…
matthewshaver Jan 9, 2024
ade0bfb
Update website/docs/reference/dbt_project.yml.md
matthewshaver Jan 9, 2024
309ab75
Update website/snippets/_cloud-environments-info.md
matthewshaver Jan 9, 2024
693f9d7
Update website/snippets/_cloud-environments-info.md
matthewshaver Jan 9, 2024
0099b29
Update website/docs/reference/project-configs/clean-targets.md
matthewshaver Jan 9, 2024
1808b95
Update website/docs/reference/project-configs/clean-targets.md
matthewshaver Jan 9, 2024
d7170e8
Update website/docs/faqs/Accounts/cloud-upgrade-instructions.md
matthewshaver Jan 10, 2024
60e6199
Update website/docs/guides/debug-schema-names.md
matthewshaver Jan 10, 2024
cf324f6
Delete website/snippets/_cloud-environments-info.md
matthewshaver Jan 10, 2024
383af84
Reverting snippet to original format
matthewshaver Jan 10, 2024
3cd46c8
Update website/docs/reference/resource-configs/delimiter.md
matthewshaver Jan 10, 2024
f62d779
Update bigquery-qs.md
matthewshaver Jan 10, 2024
b5b4823
Update databricks-qs.md
matthewshaver Jan 10, 2024
8b5fb54
Update website/docs/guides/how-to-use-databricks-workflows-to-run-dbt…
matthewshaver Jan 10, 2024
b8c4135
Update redshift-qs.md
matthewshaver Jan 10, 2024
e7a7ba5
Update website/docs/reference/project-configs/require-dbt-version.md
matthewshaver Jan 10, 2024
89a606f
Update snowflake-qs.md
matthewshaver Jan 10, 2024
672ced0
Update starburst-galaxy-qs.md
matthewshaver Jan 10, 2024
0005821
Update website/docs/reference/dbt-jinja-functions/env_var.md
matthewshaver Jan 10, 2024
8e2c8d0
Update website/docs/reference/project-configs/clean-targets.md
matthewshaver Jan 10, 2024
6e54b25
Merge branch 'current' into notices
matthewshaver Jan 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/best-practices/best-practice-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Your dbt project will depend on raw data stored in your database. Since this dat

:::info Using sources for raw data references

As of v0.13.0, we recommend defining your raw data as [sources](/docs/build/sources), and selecting from the source rather than using the direct relation reference. Our dbt projects no longer contain any direct relation references in any models.
We recommend defining your raw data as [sources](/docs/build/sources), and selecting from the source rather than using the direct relation reference. Our dbt projects don't contain any direct relation references in any models.

:::

Expand Down
18 changes: 6 additions & 12 deletions website/docs/docs/build/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,6 @@ keywords:
- groups access mesh
---

:::info New functionality
This functionality is new in v1.5.
:::

## Related docs

* [Model Access](/docs/collaborate/govern/model-access#groups)
* [Group configuration](/reference/resource-configs/group)
* [Group selection](/reference/node-selection/methods#the-group-method)

## About groups

A group is a collection of nodes within a dbt DAG. Groups are named, and every group has an `owner`. They enable intentional collaboration within and across teams by restricting [access to private](/reference/resource-configs/access) models.

Group members may include models, tests, seeds, snapshots, analyses, and metrics. (Not included: sources and exposures.) Each node may belong to only one group.
Expand Down Expand Up @@ -126,3 +114,9 @@ dbt.exceptions.DbtReferenceError: Parsing Error
Node model.jaffle_shop.marketing_model attempted to reference node model.jaffle_shop.finance_model,
which is not allowed because the referenced node is private to the finance group.
```

## Related docs

Copy link
Collaborator

Choose a reason for hiding this comment

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

Good call moving these!

* [Model Access](/docs/collaborate/govern/model-access#groups)
* [Group configuration](/reference/resource-configs/group)
* [Group selection](/reference/node-selection/methods#the-group-method)
7 changes: 0 additions & 7 deletions website/docs/docs/build/project-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,6 @@ Jinja is not supported within the `vars` config, and all values will be interpre

:::

:::info New in v0.17.0

The syntax for specifying vars in the `dbt_project.yml` file has changed in
dbt v0.17.0. See the [migration guide](/docs/dbt-versions/core-upgrade)
for more information on these changes.

:::

To define variables in a dbt project, add a `vars` config to your `dbt_project.yml` file.
These `vars` can be scoped globally, or to a specific package imported in your
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,8 @@ To set up your profile, copy the correct sample profile for your warehouse into

matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
You can find more information on which values to use in your targets below.

:::info Validating your warehouse credentials
Use the [debug](/reference/dbt-jinja-functions/debug-method) command to validate your warehouse connection. Run `dbt debug` from within a dbt project to test your connection.

Use the [debug](/reference/dbt-jinja-functions/debug-method) command to check whether you can successfully connect to your warehouse. Simply run `dbt debug` from within a dbt project to test your connection.

:::

## Understanding targets in profiles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ When querying for `environment`, you can use the following arguments.

<QueryArgsTable queryName="environment" useBetaAPI />

:::caution

dbt Labs is making changes to the Discovery API. These changes will take effect on August 15, 2023.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

The data type `Int` for `id` is being deprecated and will be replaced with `BigInt`. When the time comes, you will need to update your API call accordingly to avoid errors.
:::

### Example queries

You can use your production environment's `id`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ description: New features and changes in dbt Core v1.7
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

## Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/8aaed0e29f9560bc53d9d3e88325a9597318e375/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.6"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

dbt Core v1.6 has three significant areas of focus:
1. Next milestone of [multi-project deployments](https://github.com/dbt-labs/dbt-core/discussions/6725): improvements to contracts, groups/access, versions; and building blocks for cross-project `ref`
1. Semantic layer re-launch: dbt Core and [MetricFlow](https://docs.getdbt.com/docs/build/about-metricflow) integration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.5"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

dbt Core v1.5 is a feature release, with two significant additions:
1. [**Model governance**](/docs/collaborate/govern/about-model-governance) — access, contracts, versions — the first phase of [multi-project deployments](https://github.com/dbt-labs/dbt-core/discussions/6725)
2. A Python entry point for [**programmatic invocations**](/reference/programmatic-invocations), at parity with the CLI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: "Upgrading to dbt utils v1.0"
description: New features and breaking changes to consider as you upgrade to dbt utils v1.0.
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

# Upgrading to dbt utils v1.0

For the first time, [dbt utils](https://hub.getdbt.com/dbt-labs/dbt_utils/latest/) is crossing the major version boundary. From [last month’s blog post](https://www.getdbt.com/blog/announcing-dbt-v1.3-and-utils/):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.4"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.4.latest/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.3"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.3.latest/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.2"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.2.latest/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ id: "upgrading-to-v1.1"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.1.latest/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ id: "upgrading-to-v1.0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ displayed_sidebar: "docs"

---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />


:::caution Unsupported version
dbt Core v0.21 has reached the end of critical support. No new patch versions will be released, and it will stop running in dbt Cloud on June 30, 2022. Read ["About dbt Core versions"](/docs/dbt-versions/core) for more details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-v0.20"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

:::caution Unsupported version
dbt Core v0.20 has reached the end of critical support. No new patch versions will be released, and it will stop running in dbt Cloud on June 30, 2022. Read ["About dbt Core versions"](/docs/dbt-versions/core) for more details.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-11-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

## Schema.yml v2 syntax
dbt v0.11.0 adds an auto-generated docs site to your dbt project. To make effective use of the documentation site, you'll need to use the new "version 2" schema.yml syntax. For a full explanation of the version 2 syntax, check out the [schema.yml Files](/reference/configs-and-properties) section of the documentation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-12-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

## End of support

Support for the `repositories:` block in `dbt_project.yml` (deprecated in 0.10.0) was removed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-13-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

## Breaking changes

### on-run-start and on-run-end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-14-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

This guide outlines migration instructions for:

1. [Upgrading archives to snapshots](#upgrading-to-snapshot-blocks)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-14-1"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

The dbt v0.14.1 release _does not_ contain any breaking code changes for users upgrading from v0.14.0. If you are upgrading from a version less than 0.14.0, consult the [Upgrading to 0.14.0](upgrading-to-0-14-0) migration guide. The following section contains important information for users of the `check` strategy on Snowflake and BigQuery. Action may be required in your database.

## Changes to the Snapshot "check" algorithm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-15-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

The dbt v0.15.0 release contains a handful of breaking code changes for users upgrading from v0.14.0.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ id: "upgrading-to-0-16-0"
displayed_sidebar: "docs"
---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

dbt v0.16.0 contains many new features, bug fixes, and improvements. This guide
covers all of the important information to consider when upgrading from an earlier
version of dbt to 0.16.0.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ displayed_sidebar: "docs"

---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

dbt v0.17.0 makes compilation more consistent, improves performance, and fixes a number of bugs.

## Articles:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ displayed_sidebar: "docs"

---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/dev/marian-anderson/CHANGELOG.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ displayed_sidebar: "docs"

---

import UpgradeMove from '/snippets/_upgrade-move.md';

<UpgradeMove />

### Resources

- [Discourse](https://discourse.getdbt.com/t/1951)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [Oct-2023]
---

:::important
If you're using the legacy Semantic Layer, we **highly** recommend you [upgrade your dbt version](/docs/dbt-versions/upgrade-core-in-cloud) to dbt v1.6 or higher and [migrate](/guides/sl-migration) to the latest Semantic Layer.
If you're using the legacy Semantic Layer, we _highly_ recommend you [upgrade your dbt version](/docs/dbt-versions/upgrade-core-in-cloud) to dbt v1.6 or higher and [migrate](/guides/sl-migration) to the latest Semantic Layer.
:::

dbt Labs is thrilled to announce that the [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) is now generally available. It offers consistent data organization, improved governance, reduced costs, enhanced efficiency, and accessible data for better decision-making and collaboration across organizations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 7
---

:::important
If you're using the legacy Semantic Layer, we **highly** recommend you [upgrade your dbt version](/docs/dbt-versions/upgrade-core-in-cloud) to dbt v1.6 or higher to use the new dbt Semantic Layer. To migrate to the new Semantic Layer, refer to the dedicated [migration guide](/guides/sl-migration) for more info.
If you're using the legacy Semantic Layer, we _highly_ recommend you [upgrade your dbt version](/docs/dbt-versions/upgrade-core-in-cloud) to dbt v1.6 or higher to use the new dbt Semantic Layer. To migrate to the new Semantic Layer, refer to the dedicated [migration guide](/guides/sl-migration) for more info.
:::

dbt Labs are thrilled to announce the re-release of the [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl), now available in [public beta](#public-beta). It aims to bring the best of modeling and semantics to downstream applications by introducing:
Expand Down
6 changes: 0 additions & 6 deletions website/docs/docs/dbt-versions/upgrade-core-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,6 @@ If you believe your project might be affected, read more details in the migratio
<br></br>
<div>

:::info Important

If you have not already, you must add `config-version: 2` to your dbt_project.yml file.
See **Upgrading to v0.17.latest from v0.16** below for more details.

:::
</div>


Expand Down
4 changes: 2 additions & 2 deletions website/docs/faqs/API/rotate-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ curl --location --request POST 'https://YOUR_ACCESS_URL/api/v2/users/YOUR_USER_I
* Find your `YOUR_CURRENT_TOKEN` by going to **Profile Settings** -> **API Access** and copying the API key.
* Find [`YOUR_ACCESS_URL`](/docs/cloud/about-cloud/regions-ip-addresses) for your region and plan.

:::info Example
Example:

If `YOUR_USER_ID` = `123`, `YOUR_CURRENT_TOKEN` = `abcf9g`, and your `ACCESS_URL` = `cloud.getdbt.com`, then your curl request will be:

```
curl --location --request POST 'https://cloud.getdbt.com/api/v2/users/123/apikey/' \
--header 'Authorization: Token abcf9g'
```
:::


2. Find the new key in the API response or in dbt Cloud.

Expand Down
8 changes: 5 additions & 3 deletions website/docs/faqs/Accounts/cloud-upgrade-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ description: "Instructions for upgrading a dbt Cloud account after the trial end

dbt Cloud offers [several plans](https://www.getdbt.com/pricing/) with different features that meet your needs. This document is for dbt Cloud admins and explains how to select a plan in order to continue using dbt Cloud.

:::tip Before you begin
- You **_must_** be part of the [Owner](/docs/cloud/manage-access/self-service-permissions) user group to make billing changes. Users not included in this group will not see these options.
## Prerequisites

Before you begin:
- You _must_ be part of the [Owner](/docs/cloud/manage-access/self-service-permissions) user group to make billing changes. Users not included in this group will not see these options.
- All amounts shown in dbt Cloud are in U.S. Dollars (USD)
- When your trial expires, your account's default plan enrollment will be a Team plan.
:::



## Select a plan
Expand Down
6 changes: 0 additions & 6 deletions website/docs/guides/adapter-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -566,12 +566,6 @@ It should be noted that both of these files are included in the bootstrapped out

## Test your adapter

:::info

Previously, we offered a packaged suite of tests for dbt adapter functionality: [`pytest-dbt-adapter`](https://github.com/dbt-labs/dbt-adapter-tests). We are deprecating that suite, in favor of the newer testing framework outlined in this document.

:::

This document has two sections:

1. Refer to "About the testing framework" for a description of the standard framework that we maintain for using pytest together with dbt. It includes an example that shows the anatomy of a simple test case.
Expand Down
1 change: 0 additions & 1 deletion website/docs/guides/bigquery-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ In this quickstart guide, you'll learn how to use dbt Cloud with BigQuery. It wi

:::tip Videos for you
You can check out [dbt Fundamentals](https://courses.getdbt.com/courses/fundamentals) for free if you're interested in course learning with videos.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

:::

### Prerequisites​
Expand Down
Loading
Loading