From 411b1a8744df6173195f79c2ada528b6d6f73fbf Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Mon, 24 Jul 2023 12:10:30 -0400 Subject: [PATCH 01/17] Static IP addresses --- .../docs/cloud/about-cloud/regions-ip-addresses.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index bc8c180f2fd..506b542b51a 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -18,3 +18,13 @@ dbt Cloud is [hosted](/docs/cloud/about-cloud/architecture) in multiple regions [^1]: These regions support [multi-tenant](/docs/cloud/about-cloud/tenancy) deployment environments hosted by dbt Labs. + +## Static IP addresses + +dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. Due to this, while we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections. + +1. Dynamic IP Addresses — Our cloud infrastructure is built upon Amazon Web Services (AWS). Due to the adaptive nature of cloud services, while dbt Cloud can provide exact URLs for streamlined access, the underlying IP addresses are dynamic and will change occasionally. AWS manages the IP ranges and may change them according to their operational requirements. + +2. Embracing Hostnames for Consistent Access — To ensure uninterrupted access to dbt Cloud services, we recommend using hostnames for configurations. Hostnames provide a stable reference point that remains consistent, regardless of any changes in underlying IP addresses. This is an industry-standard pattern that's also employed by organizations such as Snowflake. + +3. Optimizing VPN Connections — Customers who leverage VPN connections, we suggest integrating a proxy alongside the VPN. This strategy allows you to maintain consistent IP addresses for your connections, facilitating seamless traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, it's crucial to set up the proxy accordingly. From 0853d3c24734bdfb09872084d9d0fe8433868361 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 31 Aug 2023 14:44:44 -0400 Subject: [PATCH 02/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index 506b542b51a..b1cfc164c2d 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -21,7 +21,7 @@ dbt Cloud is [hosted](/docs/cloud/about-cloud/architecture) in multiple regions ## Static IP addresses -dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. Due to this, while we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections. +dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections due to its cloud nature. 1. Dynamic IP Addresses — Our cloud infrastructure is built upon Amazon Web Services (AWS). Due to the adaptive nature of cloud services, while dbt Cloud can provide exact URLs for streamlined access, the underlying IP addresses are dynamic and will change occasionally. AWS manages the IP ranges and may change them according to their operational requirements. From f1cad10e5dfcd5cc9627c9b6d8b7938c38c5cc48 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 31 Aug 2023 14:44:56 -0400 Subject: [PATCH 03/17] Apply suggestions from code review Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index b1cfc164c2d..80978fe63f9 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -23,8 +23,8 @@ dbt Cloud is [hosted](/docs/cloud/about-cloud/architecture) in multiple regions dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections due to its cloud nature. -1. Dynamic IP Addresses — Our cloud infrastructure is built upon Amazon Web Services (AWS). Due to the adaptive nature of cloud services, while dbt Cloud can provide exact URLs for streamlined access, the underlying IP addresses are dynamic and will change occasionally. AWS manages the IP ranges and may change them according to their operational requirements. +1. Dynamic IP addresses — Our cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers exact URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. This is because AWS manages the IP ranges and may change them according to their operational needs. -2. Embracing Hostnames for Consistent Access — To ensure uninterrupted access to dbt Cloud services, we recommend using hostnames for configurations. Hostnames provide a stable reference point that remains consistent, regardless of any changes in underlying IP addresses. This is an industry-standard pattern that's also employed by organizations such as Snowflake. +2. Embracing hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, we recommend using hostnames for configurations. Hostnames provide a stable reference point that remains consistent, regardless of any changes in underlying IP addresses. This is an industry-standard pattern that's also employed by organizations such as Snowflake. -3. Optimizing VPN Connections — Customers who leverage VPN connections, we suggest integrating a proxy alongside the VPN. This strategy allows you to maintain consistent IP addresses for your connections, facilitating seamless traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, it's crucial to set up the proxy accordingly. +3. Optimizing VPN connections — We suggest integrating a proxy alongside the VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, it's crucial to set up the proxy accordingly. From b9afd701b23d08b686666bb033ee30393031f206 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 19 Oct 2023 19:40:57 -0400 Subject: [PATCH 04/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index 9a65397f105..cf1ac6ba104 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -30,7 +30,7 @@ There are two ways to view your dbt Cloud IP addresses: dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections due to its cloud nature. -1. Dynamic IP addresses — Our cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers exact URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. This is because AWS manages the IP ranges and may change them according to their operational needs. +1. Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. 2. Embracing hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, we recommend using hostnames for configurations. Hostnames provide a stable reference point that remains consistent, regardless of any changes in underlying IP addresses. This is an industry-standard pattern that's also employed by organizations such as Snowflake. From 16aabd5f9facd058b7fc87bfc49d90d6b862742e Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 19 Oct 2023 19:44:14 -0400 Subject: [PATCH 05/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index cf1ac6ba104..9585662b03b 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -32,6 +32,6 @@ dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructu 1. Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. -2. Embracing hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, we recommend using hostnames for configurations. Hostnames provide a stable reference point that remains consistent, regardless of any changes in underlying IP addresses. This is an industry-standard pattern that's also employed by organizations such as Snowflake. +2. Using hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, it's recommended that you use hostnames for configurations. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. This is an industry-standard practice employed by organizations such as Snowflake. 3. Optimizing VPN connections — We suggest integrating a proxy alongside the VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, it's crucial to set up the proxy accordingly. From 23a04133aa6e6277be4e8b98ec8c37dce6f11345 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Fri, 27 Oct 2023 16:01:38 -0400 Subject: [PATCH 06/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index 9585662b03b..fc2a3676c11 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -34,4 +34,4 @@ dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructu 2. Using hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, it's recommended that you use hostnames for configurations. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. This is an industry-standard practice employed by organizations such as Snowflake. -3. Optimizing VPN connections — We suggest integrating a proxy alongside the VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, it's crucial to set up the proxy accordingly. +3. Optimizing VPN connections &mdash: You should integrate a proxy alongside VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, setting up the proxy accordingly is crucial. From bdf9e138b0f7bb6f7c472b02d8a6d433299dce94 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Fri, 27 Oct 2023 16:02:53 -0400 Subject: [PATCH 07/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index fc2a3676c11..0c2aa790489 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -28,7 +28,7 @@ There are two ways to view your dbt Cloud IP addresses: ### Static IP addresses -dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer exact URLs for access, we're unable to provide a list of static IP addresses to configure connections due to its cloud nature. +dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer static URLs for access, we cannot provide a list of IP addresses to configure connections due to the nature of AWS cloud services. 1. Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. From ab81cd3ee854a39394c90524cc92abb177ece850 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Mon, 30 Oct 2023 16:47:08 -0400 Subject: [PATCH 08/17] 1.7 beta to GA --- website/dbt-versions.js | 3 +-- website/docs/guides/migration/versions/00-upgrading-to-v1.7.md | 2 +- website/docs/guides/migration/versions/01-upgrading-to-v1.6.md | 2 +- website/snippets/core-versions-table.md | 3 +-- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/website/dbt-versions.js b/website/dbt-versions.js index 910c4a6ef4d..be55c893041 100644 --- a/website/dbt-versions.js +++ b/website/dbt-versions.js @@ -1,8 +1,7 @@ exports.versions = [ { version: "1.7", - EOLDate: "2024-07-31", - isPrerelease: "true" + EOLDate: "2024-10-30", }, { version: "1.6", diff --git a/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md b/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md index f350e8955f7..4bd787c1ad3 100644 --- a/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md +++ b/website/docs/guides/migration/versions/00-upgrading-to-v1.7.md @@ -1,5 +1,5 @@ --- -title: "Upgrading to v1.7 (beta)" +title: "Upgrading to v1.7 (latest)" description: New features and changes in dbt Core v1.7 --- diff --git a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md b/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md index 50b0ca8bc58..2a62afe0f48 100644 --- a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md +++ b/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md @@ -1,5 +1,5 @@ --- -title: "Upgrading to v1.6 (latest)" +title: "Upgrading to v1.6" description: New features and changes in dbt Core v1.6 --- diff --git a/website/snippets/core-versions-table.md b/website/snippets/core-versions-table.md index b08c23c84c5..940f4ea6957 100644 --- a/website/snippets/core-versions-table.md +++ b/website/snippets/core-versions-table.md @@ -2,7 +2,7 @@ | dbt Core | Initial Release | Support Level | Critical Support Until | |------------------------------------------------------------|-----------------|----------------|-------------------------| -| [**v1.7**](/guides/migration/versions/upgrading-to-v1.7) (beta)| Oct 26, 2023 | - | - | +| [**v1.7**](/guides/migration/versions/upgrading-to-v1.7) | Oct 31, 2023 | Active | Oct 30, 2024 | | [**v1.6**](/guides/migration/versions/upgrading-to-v1.6) | Jul 31, 2023 | Active | Jul 30, 2024 | | [**v1.5**](/guides/migration/versions/upgrading-to-v1.5) | Apr 27, 2023 | Critical | Apr 27, 2024 | | [**v1.4**](/guides/migration/versions/upgrading-to-v1.4) | Jan 25, 2023 | Critical | Jan 25, 2024 | @@ -18,6 +18,5 @@ _Future release dates are tentative and subject to change._ | dbt Core | Planned Release | Critical & dbt Cloud Support Until | |----------|-----------------|-------------------------------------| -| **v1.7** | _Oct 2023_ | _Oct 2024_ | | **v1.8** | _Jan 2024_ | _Jan 2025_ | | **v1.9** | _Apr 2024_ | _Apr 2025_ | From 405463eaf7914e57c269bb67f1063f4b547ebf1a Mon Sep 17 00:00:00 2001 From: Will Stamatis <114952643+wlsdbt@users.noreply.github.com> Date: Tue, 31 Oct 2023 13:36:56 -0400 Subject: [PATCH 09/17] Update clone.md included Kshitij's article on dbt clone vs. deferral. --- website/docs/reference/commands/clone.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/reference/commands/clone.md b/website/docs/reference/commands/clone.md index ea3e570447d..9852ce84c17 100644 --- a/website/docs/reference/commands/clone.md +++ b/website/docs/reference/commands/clone.md @@ -37,3 +37,5 @@ Unlike deferral, `dbt clone` requires some compute and creation of additional ob For example, by creating actual data warehouse objects, `dbt clone` allows you to test out your code changes on downstream dependencies _outside of dbt_ (such as a BI tool). As another example, you could `clone` your modified incremental models as the first step of your dbt Cloud CI job to prevent costly `full-refresh` builds for warehouses that support zero-copy cloning. + +Check out [this Developer blog post](https://docs.getdbt.com/blog/to-defer-or-to-clone) for more details on best practices when to use `dbt clone` vs. deferral. From c2c725e6d3e0afd6bd5a5275b98b92a731c1aabe Mon Sep 17 00:00:00 2001 From: Brian Crant <17074379+bcrant@users.noreply.github.com> Date: Tue, 31 Oct 2023 11:35:18 -0700 Subject: [PATCH 10/17] Update materializations-guide-4-incremental-models.md Match description with the IDs used in the table. --- .../materializations-guide-4-incremental-models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md b/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md index 603cbc8cda1..cd4264bafd3 100644 --- a/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md +++ b/website/docs/guides/best-practices/materializations/materializations-guide-4-incremental-models.md @@ -29,7 +29,7 @@ We did our last `dbt build` job on `2022-01-31`, so any new orders since that ru - 🏔️ build the table from the **beginning of time again — a _table materialization_** - Simple and solid, if we can afford to do it (in terms of time, compute, and money — which are all directly correlated in a cloud warehouse). It’s the easiest and most accurate option. - 🤏 find a way to run **just new and updated rows since our previous run — _an_ _incremental materialization_** - - If we _can’t_ realistically afford to run the whole table — due to complex transformations or big source data, it takes too long — then we want to build incrementally. We want to just transform and add the row with id 567 below, _not_ the previous two with ids 123 and 456 that are already in the table. + - If we _can’t_ realistically afford to run the whole table — due to complex transformations or big source data, it takes too long — then we want to build incrementally. We want to just transform and add the row with id 567 below, _not_ the previous two with ids 123 and 234 that are already in the table. | order_id | order_status | customer_id | order_item_id | ordered_at | updated_at | | -------- | ------------ | ----------- | ------------- | ---------- | ---------- | From 4e21bfbfe1327e4eb0cccb0c079ee440476c8525 Mon Sep 17 00:00:00 2001 From: Isabela Sobral <35778239+belasobral93@users.noreply.github.com> Date: Wed, 1 Nov 2023 09:07:54 -0700 Subject: [PATCH 11/17] Update set-up-sso-saml-2.0.md removed mention of Okta in the generic setup instructions --- website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md b/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md index 5ccb2600005..ba925fa2c24 100644 --- a/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md +++ b/website/docs/docs/cloud/manage-access/set-up-sso-saml-2.0.md @@ -89,7 +89,7 @@ them to complete setup in dbt Cloud. ### Finish setup -After creating the Okta application, follow the instructions in the [dbt Cloud Setup](#dbt-cloud-setup) +After creating the application, follow the instructions in the [dbt Cloud Setup](#dbt-cloud-setup) section to complete the integration. ## Okta integration From efdd7f3b33b957522d2eb20ecd251808030de1f3 Mon Sep 17 00:00:00 2001 From: Talla Date: Thu, 2 Nov 2023 03:46:11 +0530 Subject: [PATCH 12/17] Update teradata-setup.md --- .../docs/core/connect-data-platform/teradata-setup.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/docs/core/connect-data-platform/teradata-setup.md b/website/docs/docs/core/connect-data-platform/teradata-setup.md index 9f6c6b6f0b6..e62eeaf89b6 100644 --- a/website/docs/docs/core/connect-data-platform/teradata-setup.md +++ b/website/docs/docs/core/connect-data-platform/teradata-setup.md @@ -56,11 +56,11 @@ pip is the easiest way to install the adapter: |1.5.x | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |1.6.x | ❌ | ❌ | ✅ | ✅ | ✅ | ✅ -

Python compatibility

+

dbt dependent packages version compatibility

-| dbt-teradta | dbt-core | dbt-teradata-util | dbt-util | -|-------------|------------|-------------------|----------------| -| 1.2.x | 1.2.x | 0.1.0 | 0.9.x or below | +| dbt-teradata | dbt-core | dbt-teradata-util | dbt-util | +|--------------|------------|-------------------|----------------| +| 1.2.x | 1.2.x | 0.1.0 | 0.9.x or below |

Configuring {frontMatter.meta.pypi_package}

From d860b14f5f926e8a106c2456a1c3ddbc7b9de1ff Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Wed, 1 Nov 2023 19:21:18 -0600 Subject: [PATCH 13/17] Update `dbt-cloud` config syntax links for `dbt_project.yml` --- website/docs/reference/dbt_project.yml.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/reference/dbt_project.yml.md b/website/docs/reference/dbt_project.yml.md index 571e930d7da..9bd85d0d5dd 100644 --- a/website/docs/reference/dbt_project.yml.md +++ b/website/docs/reference/dbt_project.yml.md @@ -11,7 +11,7 @@ By default, dbt will look for `dbt_project.yml` in your current working director By default, dbt will look for `dbt_project.yml` in your current working directory and its parents, but you can set a different directory using the `--project-dir` flag or the `DBT_PROJECT_DIR` environment variable. -Starting from dbt v1.5 and higher, you can specify your dbt Cloud project ID in the `dbt_project.yml` file using the `dbt-cloud` config, which doesn't require validation or storage in the project config class. To find your project ID, check your dbt Cloud project URL, such as `https://cloud.getdbt.com/11/projects/123456`, where the project ID is `123456`. +Starting from dbt v1.5 and higher, you can specify your dbt Cloud project ID in the `dbt_project.yml` file using `project-id` under the `dbt-cloud` config. To find your project ID, check your dbt Cloud project URL, such as `https://cloud.getdbt.com/11/projects/123456`, where the project ID is `123456`. @@ -54,8 +54,8 @@ dbt uses YAML in a few different places. If you're new to YAML, it would be wort [require-dbt-version](/reference/project-configs/require-dbt-version): version-range | [version-range] [dbt-cloud](/docs/cloud/cloud-cli-installation): - project-id: project_id #Required - defer-env-id: 5678 #Optional + [project-id](/docs/cloud/configure-cloud-cli#configure-the-dbt-cloud-cli): project_id # Required + [defer-env-id](/docs/cloud/about-cloud-develop-defer#defer-in-dbt-cloud-cli): environment_id # Optional [quoting](/reference/project-configs/quoting): database: true | false From 31c5305396415a2607f21605f38770ccdbe6f89d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 2 Nov 2023 16:59:42 +0000 Subject: [PATCH 14/17] Update content-style-guide.md (#4341) adding this official stance to the style guide to ensure correct terminology is used --------- Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- contributing/content-style-guide.md | 35 ++++++++++++++++++----------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index eaa090a00b6..204c5c854f4 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -229,7 +229,7 @@ When referring to different sections of the IDE, use the name of the section and People make use of titles in many places like table headers, section headings (such as an H2, H3, or H4), page titles, sidebars, and so much more. -When generating titles or updating them, use sentence case. It sets a more conversational tone to the docs—making the content more approachable and creating a friendly feel. +When generating titles or updating them, use sentence case. It sets a more conversational tone to the docs— making the content more approachable and creating a friendly feel. We've defined five content types you can use when contributing to the docs (as in, writing or authoring). Learn more about title guidelines for [each content type](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-types.md). @@ -239,7 +239,7 @@ Placeholder text is something that the user should replace with their own text. Use all capital letters([screaming snake case](https://fission.codes/blog/screaming-snake-case/)) to indicate text that changes in the user interface or that the user needs to supply in a command or code snippet. Avoid surrounding it in brackets or braces, which someone might copy and use, producing an error. -Identify what the user should replace the placeholder text with in the paragraph preceding the code snippet or command. +Identify what the user should replace the placeholder text within the paragraph preceding the code snippet or command. :white_check_mark: The following is an example of configuring a connection to a Redshift database. In your YAML file, you must replace `CLUSTER_ID` with the ID assigned to you during setup: @@ -276,7 +276,7 @@ Guidelines for making lists are: - There are at least two items. - All list items follow a consistent, grammatical structure (like each item starts with a verb, each item begins with a capitalized word, each item is a sentence fragment). - Lists items don't end in commas, semicolons, or conjunctions (like "and", "or"). However, you can use periods if they’re complete sentences. -- Introduce the list with a heading or, if it's within text, as a complete sentence or as a sentence fragment followed by a colon. +- Introduce the list with a heading or, if it's within the text, as a complete sentence or as a sentence fragment followed by a colon. If the list starts getting lengthy and dense, consider presenting the same content in a different format such as a table, as separate subsections, or a new guide. @@ -286,7 +286,7 @@ A bulleted list with introductory text: > A dbt project is a directory of `.sql` and .yml` files. The directory must contain at a minimum: > -> - Models: A model is a single `.sql` file. Each model contains a single `select` statement that either transforms raw data into a dataset that is ready for analytics, or, more often, is an intermediate step in such a transformation. +> - Models: A model is a single `.sql` file. Each model contains a single `select` statement that either transforms raw data into a dataset that is ready for analytics or, more often, is an intermediate step in such a transformation. > - A project file: A `dbt_project.yml` file, which configures and defines your dbt project. A bulleted list with sentence fragments: @@ -307,10 +307,10 @@ A numbered list following an H2 heading: ## Tables Tables provide a great way to present complex information and can help the content be more scannable for users, too. -There are many ways to construct a table, like row spanning and cell splitting. Make sure the content is clear, concise, and presents well on the web page (like avoid awkward word wrapping). +There are many ways to construct a table, such as row spanning and cell splitting. The content should be clear, concise, and presented well on the web page (for example, avoid awkward word wrapping). Guidelines for making tables are: -- Introduce the table with a heading or, if it's within text, as a complete sentence or as a sentence fragment followed by a colon. +- Introduce the table with a heading or, if it's within the text, as a complete sentence or as a sentence fragment followed by a colon. - Use a header row - Use sentence case for all content, including the header row - Content can be complete sentences, sentence fragments, or single words (like `Currency`) @@ -338,7 +338,7 @@ A table following an H3 heading: > | Name | Description | Values | > | -----| ----------- | ------ | > | `-help` | Displays information on how to use the command. | Doesn't take any values. | -> | `-readable` | Print output in human readable format. | | +> | `-readable` | Print output in human-readable format. | | > | `-file` | Print output to file instead of stdout. | Name of the file. | ## Cards @@ -349,7 +349,7 @@ You can configure a card in 2, 3, 4, or 5-column grids. To maintain a good user There won't be many instances where you need to display 4 or 5 cards on the docs site. While we recommend you use 2 or 3-column grids, you can use 4 or 5-column grids in the following scenarios: -- For cards that contain little text and limited to under 15 words. (This is to make sure the text isn't squished) +- For cards that contain little text and are limited to 15 words or less. This is to make sure the text isn't squished. - Always have the `hide_table_of_contents:` frontmatter set to `true` (This hides the right table of contents). Otherwise, the text will appear squished and provide users with a bad experience. @@ -371,16 +371,16 @@ To create cards in markdown, you need to: - Add the props within the card component, including `title`,`body`,`link`,`icon`. - Close out the div by using `` -Refer to the following prop list for detailed explanation and examples: +Refer to the following prop list for detailed explanations and examples: | Prop | Type | Info | Example | | ---- | ---- | ---- | ------- | | `title` | required | The title should be clear and explain an action the user should take or a product/feature. | `title: dbt Cloud IDE` | `body` | required | The body contains the actionable or informative text for the user. You can include `` | +| `icon` | optional but recommended | You can add an icon to the card component by using any icons found in the [icons](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/static/img/icons) directory.
* Icons are added in .svg format and you must add icons in two locations: website/static/img/icons and website/static/img/icons/white. This is so users can view the icons in dark or light mode on the docs.getdbt.com site. | ` icon="pencil-paper"/>` | -The following is an example of a 4 card column: +The following is an example of a 4-card column: ```
@@ -488,9 +488,16 @@ Avoid ending a sentence with a preposition unless the rewritten sentence would s Product names, trademarks, services, and tools should be written as proper nouns, unless otherwise specified by the company or trademark owner. +As of October 2023, avoid using "dbt CLI" or "CLI" terminology when referring to the dbt Cloud CLI or dbt Core. However, if referring to the command line as a tool, CLI is acceptable. + +dbt officially provides two command line tools for running dbt commands: + +- [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) — This tool allows you to develop locally and execute dbt commands against your dbt Cloud development environment from your local command line. +- [dbt Core](https://github.com/dbt-labs/dbt-core) — This open-source tool is designed for local installation, enabling you to use dbt Core on the command line and communicate with databases through adapters. + ### Terms to use or avoid -Use industry-specific terms and research new/improved terminology. Also refer to the Inclusive Language section of this style guide for inclusive and accessible language and style. +Use industry-specific terms and research new/improved terminology. Also, refer to the Inclusive Language section of this style guide for inclusive and accessible language and style. **DO NOT** use jargon or language familiar to a small subset of readers or assume that your readers understand ALL technical terms. @@ -507,11 +514,13 @@ sign in | log in, login sign up | signup terminal | shell username | login +dbt Cloud CLI | CLI, dbt CLI +dbt Core | CLI, dbt CLI
## Links -Links embedded in documentation are about trust. Users trust that we will lead them to sites or pages related to their reading content. In order to maintain that trust, it's important that links are transparent, up-to-date, and lead to legitimate resources. +Links embedded in the documentation are about trust. Users trust that we will lead them to sites or pages related to their reading content. In order to maintain that trust, it's important that links are transparent, up-to-date, and lead to legitimate resources. ### Internal links From d8efce763086d690a0983918c4988c91e5845877 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 2 Nov 2023 14:47:24 -0400 Subject: [PATCH 15/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com> --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index 0c2aa790489..bd3afb36814 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -32,6 +32,6 @@ dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructu 1. Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. -2. Using hostnames for consistent access — To ensure uninterrupted access to dbt Cloud services, it's recommended that you use hostnames for configurations. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. This is an industry-standard practice employed by organizations such as Snowflake. +* Using hostnames for consistent access — To ensure uninterrupted access, we recommend that you dbt Cloud services using hostnames. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. We are aligning with an industry-standard practice employed by organizations such as Snowflake. 3. Optimizing VPN connections &mdash: You should integrate a proxy alongside VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, setting up the proxy accordingly is crucial. From cdcc6f20f1fe32e700abd3a8cea5dc3a8bae15ea Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 2 Nov 2023 14:47:30 -0400 Subject: [PATCH 16/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com> --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index bd3afb36814..348a6000b57 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -34,4 +34,4 @@ dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructu * Using hostnames for consistent access — To ensure uninterrupted access, we recommend that you dbt Cloud services using hostnames. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. We are aligning with an industry-standard practice employed by organizations such as Snowflake. -3. Optimizing VPN connections &mdash: You should integrate a proxy alongside VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, traffic can be directed through the VPN and then to dbt Cloud. If there's any need to integrate with additional services, setting up the proxy accordingly is crucial. +* Optimizing VPN connections &mdash: You should integrate a proxy alongside VPN for users who leverage VPN connections. This strategy enables steady IP addresses for your connections, facilitating smooth traffic flow through the VPN and onward to dbt Cloud. By employing a proxy and a VPN, you can direct traffic through the VPN and then to dbt Cloud. It's crucial to set up the proxy if you need to integrate with additional services. From 025a2cd2b0c2e3e8ba2881ea28695e82982e5181 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Thu, 2 Nov 2023 14:47:51 -0400 Subject: [PATCH 17/17] Update website/docs/docs/cloud/about-cloud/regions-ip-addresses.md --- website/docs/docs/cloud/about-cloud/regions-ip-addresses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md index 348a6000b57..4fcabbb3585 100644 --- a/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md +++ b/website/docs/docs/cloud/about-cloud/regions-ip-addresses.md @@ -30,7 +30,7 @@ There are two ways to view your dbt Cloud IP addresses: dbt Cloud, like many cloud services, relies on underlying AWS cloud infrastructure for operations. While we can offer static URLs for access, we cannot provide a list of IP addresses to configure connections due to the nature of AWS cloud services. -1. Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. +* Dynamic IP addresses — dbt Cloud infrastructure uses Amazon Web Services (AWS). dbt Cloud offers static URLs for streamlined access, but the dynamic nature of cloud services means the underlying IP addresses change occasionally. AWS manages the IP ranges and may change them according to their operational and security needs. * Using hostnames for consistent access — To ensure uninterrupted access, we recommend that you dbt Cloud services using hostnames. Hostnames provide a consistent reference point, regardless of any changes in underlying IP addresses. We are aligning with an industry-standard practice employed by organizations such as Snowflake.