From bfe637b17064dba457c8d316028abda82d57da47 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 1 Feb 2024 13:47:45 +0000 Subject: [PATCH 1/6] clarify cloud cli config file confusion this pr adds clarification that the user should store the dbt_cloud.yml file in a safe place and that it should be saved in their local computer storage per slack thread: https://dbt-labs.slack.com/archives/C06FWKP5V28/p1706649874140829 from @TimKlense --- .../docs/docs/cloud/configure-cloud-cli.md | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index acd77bfd23b..ee380e33006 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -22,17 +22,23 @@ import CloudCLIFlag from '/snippets/_cloud-cli-flag.md'; Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt Cloud project. -1. Ensure you meet the prerequisites above. - -2. Download your credentials from dbt Cloud by clicking on the **Try the dbt Cloud CLI** banner on the dbt Cloud homepage. Alternatively, if you're in dbt Cloud, you can download the credentials from the links provided based on your region: +1. Ensure you meet the prerequisites above and go to dbt Cloud to download your credentials by clicking on the **Try the dbt Cloud CLI** banner. + +
+ Click to expand the URLs based on your region + You can also download the credentials from the links provided based on your region: - North America: https://cloud.getdbt.com/cloud-cli - EMEA: https://emea.dbt.com/cloud-cli - APAC: https://au.dbt.com/cloud-cli - North American Cell 1: `https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli` - Single-tenant: `https://YOUR_ACCESS_URL/cloud-cli` + +
+ -3. Follow the banner instructions and download the config file to: +2. Save the config file to your local computer's filesystem. Make sure to store your `dbt_cloud.yml` config file in a safe place as it contains API keys. + - Mac or Linux: `~/.dbt/dbt_cloud.yml` - Windows: `C:\Users\yourusername\.dbt\dbt_cloud.yml` @@ -52,16 +58,15 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt - project-id: "" account-host: "" api-key: "" - ``` -4. After downloading the config file, navigate to a dbt project in your terminal: +3. After downloading the config file, navigate to a dbt project in your terminal: ```bash cd ~/dbt-projects/jaffle_shop ``` -5. In your `dbt_project.yml` file, ensure you have or include a `dbt-cloud` section with a `project-id` field. The `project-id` field contains the dbt Cloud project ID you want to use. +4. In your `dbt_project.yml` file, ensure you have or include a `dbt-cloud` section with a `project-id` field. The `project-id` field contains the dbt Cloud project ID you want to use. ```yaml # dbt_project.yml @@ -75,7 +80,7 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt - To find your project ID, select **Develop** in the dbt Cloud navigation menu. You can use the URL to find the project ID. For example, in `https://cloud.getdbt.com/develop/26228/projects/123456`, the project ID is `123456`. -6. You should now be able to [use the dbt Cloud CLI](#use-the-dbt-cloud-cli) and run [dbt commands](/reference/dbt-commands) like [`dbt environment show`](/reference/commands/dbt-environment) to view your dbt Cloud configuration details or `dbt compile` to compile models in your dbt project. +5. You should now be able to [use the dbt Cloud CLI](#use-the-dbt-cloud-cli) and run [dbt commands](/reference/dbt-commands) like [`dbt environment show`](/reference/commands/dbt-environment) to view your dbt Cloud configuration details or `dbt compile` to compile models in your dbt project. With your repo recloned, you can add, edit, and sync files with your repo. From de8860a19e019a931b2f1d8c0fa7aef561418f86 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 1 Feb 2024 13:52:44 +0000 Subject: [PATCH 2/6] Update configure-cloud-cli.md --- website/docs/docs/cloud/configure-cloud-cli.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index ee380e33006..8646f74c719 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -25,16 +25,17 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt 1. Ensure you meet the prerequisites above and go to dbt Cloud to download your credentials by clicking on the **Try the dbt Cloud CLI** banner.
- Click to expand the URLs based on your region + + Click to expand the URLs based on your region You can also download the credentials from the links provided based on your region: - North America: https://cloud.getdbt.com/cloud-cli - EMEA: https://emea.dbt.com/cloud-cli - APAC: https://au.dbt.com/cloud-cli - - North American Cell 1: `https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli` - - Single-tenant: `https://YOUR_ACCESS_URL/cloud-cli` - -
+ - North American Cell 1: https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli + - Single-tenant: https://YOUR_ACCESS_URL/cloud-cli + + 2. Save the config file to your local computer's filesystem. Make sure to store your `dbt_cloud.yml` config file in a safe place as it contains API keys. From 379c60d6688bdf824fab656e9fb5fcc3f034419d Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 1 Feb 2024 14:02:50 +0000 Subject: [PATCH 3/6] fix error --- .../docs/docs/cloud/configure-cloud-cli.md | 25 ++++++++----------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 8646f74c719..510c3891213 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -10,7 +10,6 @@ import CloudCLIFlag from '/snippets/_cloud-cli-flag.md'; - ## Prerequisites - You must set up a project in dbt Cloud. @@ -23,21 +22,19 @@ import CloudCLIFlag from '/snippets/_cloud-cli-flag.md'; Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt Cloud project. 1. Ensure you meet the prerequisites above and go to dbt Cloud to download your credentials by clicking on the **Try the dbt Cloud CLI** banner. - +
- - Click to expand the URLs based on your region - You can also download the credentials from the links provided based on your region: - - - North America: https://cloud.getdbt.com/cloud-cli - - EMEA: https://emea.dbt.com/cloud-cli - - APAC: https://au.dbt.com/cloud-cli - - North American Cell 1: https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli - - Single-tenant: https://YOUR_ACCESS_URL/cloud-cli - +Region URLs to download credentials +You can also download the credentials from the links provided based on your region: + +- North America: https://cloud.getdbt.com/cloud-cli +- EMEA: https://emea.dbt.com/cloud-cli +- APAC: https://au.dbt.com/cloud-cli +- North American Cell 1: https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli +- Single-tenant: https://YOUR_ACCESS_URL/cloud-cli +
- - + 2. Save the config file to your local computer's filesystem. Make sure to store your `dbt_cloud.yml` config file in a safe place as it contains API keys. - Mac or Linux: `~/.dbt/dbt_cloud.yml` From 03642782c6fe08895e57867a8917d616ed06eb68 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 1 Feb 2024 14:03:54 +0000 Subject: [PATCH 4/6] fix spacing --- website/docs/docs/cloud/configure-cloud-cli.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 510c3891213..7a673d4a18a 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -23,17 +23,17 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt 1. Ensure you meet the prerequisites above and go to dbt Cloud to download your credentials by clicking on the **Try the dbt Cloud CLI** banner. -
-Region URLs to download credentials -You can also download the credentials from the links provided based on your region: +
+ Region URLs to download credentials + You can also download the credentials from the links provided based on your region: -- North America: https://cloud.getdbt.com/cloud-cli -- EMEA: https://emea.dbt.com/cloud-cli -- APAC: https://au.dbt.com/cloud-cli -- North American Cell 1: https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli -- Single-tenant: https://YOUR_ACCESS_URL/cloud-cli + - North America: https://cloud.getdbt.com/cloud-cli + - EMEA: https://emea.dbt.com/cloud-cli + - APAC: https://au.dbt.com/cloud-cli + - North American Cell 1: https:/ACCOUNT_PREFIX.us1.dbt.com/cloud-cli + - Single-tenant: https://YOUR_ACCESS_URL/cloud-cli -
+
2. Save the config file to your local computer's filesystem. Make sure to store your `dbt_cloud.yml` config file in a safe place as it contains API keys. From 2205e6657edad274f0efa8f97a9c52fca9647432 Mon Sep 17 00:00:00 2001 From: "Nicholas A. Yager" Date: Thu, 1 Feb 2024 09:46:10 -0500 Subject: [PATCH 5/6] Remove duplicate `log_format` in profiles.yml.md The `log_format` property for profiles.yml.md appears twice in the provided documentation. --- website/docs/docs/core/connect-data-platform/profiles.yml.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/core/connect-data-platform/profiles.yml.md b/website/docs/docs/core/connect-data-platform/profiles.yml.md index c9a66010a50..8fe4f321d2f 100644 --- a/website/docs/docs/core/connect-data-platform/profiles.yml.md +++ b/website/docs/docs/core/connect-data-platform/profiles.yml.md @@ -33,7 +33,6 @@ This section identifies the parts of your `profiles.yml` that aren't specific to [static_parser](/reference/global-configs/parsing): [cache_selected_only](/reference/global-configs/cache): [printer_width](/reference/global-configs/print-output#printer-width): - [log_format](/reference/global-configs/logs): : target: # this is the default target From 34f7e8561fb9cedd1baaaeb7045c857fc60ef51b Mon Sep 17 00:00:00 2001 From: Jason Karlavige Date: Thu, 1 Feb 2024 09:59:16 -0500 Subject: [PATCH 6/6] Update docs banner Updates docs banner text to change "weekly" to "bi-weekly" --- website/docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index b4b758e7744..d1cb02203d9 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -71,7 +71,7 @@ var siteSettings = { }, announcementBar: { id: "biweekly-demos", - content: "Join our weekly demos and see dbt Cloud in action!", + content: "Join our bi-weekly demos and see dbt Cloud in action!", backgroundColor: "#047377", textColor: "#fff", isCloseable: true,