Update mentions of dbt CLI #4356

matthewshaver · 2023-10-27T15:37:55Z

What are you changing in this pull request and why?

Updates old mentions of dbt CLI to say either dbt Core or dbt Core CLI depending on the context.

Checklist

Review the Content style guide and About versioning so my content adheres to these guidelines.
Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

vercel · 2023-10-27T15:38:01Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 27, 2023 6:27pm

mirnawong1 · 2023-10-27T15:44:46Z

website/docs/dbt-cli/cli-overview.md

@@ -3,7 +3,7 @@ title: "CLI overview"
 description: "Run your dbt project from the command line."
 ---

-dbt Core ships with a command-line interface (CLI) for running your dbt project. The dbt CLI is free to use and available as an [open source project](https://github.com/dbt-labs/dbt-core).
+dbt Core ships with a command-line interface (CLI) for running your dbt project. dbt Core and it's CLI are free to use and available as an [open source project](https://github.com/dbt-labs/dbt-core).


is this page referenced anywhere? if not, we should prob remove it because its one of those pages that's not even in the sidebar or anything https://docs.getdbt.com/dbt-cli/cli-overview

It still gets hundreds of views a week so let me check with PM about whether we should remove it entirely or move this content elsewhere. I'll create a follow up PR based on their answer

I agree we should remove it (and move content if we need to.) Maybe redirect it to https://docs.getdbt.com/docs/core/about-dbt-core ?

Also check if any docs link to it!

runleonarun

@matthewshaver Just found a few places where I'd remove "CLI" but looks great! Thanks for spinning this up and helping to reduce confusion.

website/docs/dbt-cli/cli-overview.md

runleonarun · 2023-10-27T16:52:53Z

website/docs/dbt-cli/cli-overview.md

@@ -3,7 +3,7 @@ title: "CLI overview"
 description: "Run your dbt project from the command line."
 ---

-dbt Core ships with a command-line interface (CLI) for running your dbt project. The dbt CLI is free to use and available as an [open source project](https://github.com/dbt-labs/dbt-core).
+dbt Core ships with a command-line interface (CLI) for running your dbt project. dbt Core and it's CLI are free to use and available as an [open source project](https://github.com/dbt-labs/dbt-core).


I agree we should remove it (and move content if we need to.) Maybe redirect it to https://docs.getdbt.com/docs/core/about-dbt-core ?

Also check if any docs link to it!

runleonarun · 2023-10-27T16:54:11Z

website/docs/docs/build/jinja-macros.md

@@ -76,7 +76,7 @@ You can recognize Jinja based on the delimiters the language uses, which we refe

 When used in a dbt model, your Jinja needs to compile to a valid query. To check what SQL your Jinja compiles to:
 * **Using dbt Cloud:** Click the compile button to see the compiled SQL in the Compiled SQL pane
-* **Using the dbt CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.
+* **Using the dbt Core CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.


I'd remove CLI here because we say "command line" and it feels like core/cloud comparison

Suggested change

* **Using the dbt Core CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.

* **Using the dbt Core:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.

Removing "the" as well in this case

website/docs/faqs/Runs/checking-logs.md

runleonarun · 2023-10-27T16:57:31Z

website/docs/guides/advanced/using-jinja.md

@@ -9,7 +9,7 @@ If you'd like to work through this query, add [this CSV](https://github.com/dbt-

 While working through the steps of this model, we recommend that you have your compiled SQL open as well, to check what your Jinja compiles to. To do this:
 * **Using dbt Cloud:** Click the compile button to see the compiled SQL in the right hand pane
-* **Using the dbt CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.
+* **Using the dbt Core CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.


This is redundant, so best to drop CLI

Suggested change

* **Using the dbt Core CLI:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.

* **Using the dbt Core:** Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.

Need to remove "the" in this case. Fixing in follow up coment

Co-authored-by: Leona B. Campbell <[email protected]>

website/docs/guides/advanced/using-jinja.md

Co-authored-by: Leona B. Campbell <[email protected]>

website/docs/docs/build/jinja-macros.md

runleonarun

Looks great!

olycats · 2023-10-28T05:49:59Z

Thank you @matthewshaver - I was confused about that too.

Update mentions of dbt CLI

3b1df8c

matthewshaver requested a review from a team as a code owner October 27, 2023 15:37

Merge branch 'current' into core-cli

547bae8

github-actions bot added content Improvements or additions to content developer blog This content fits on the developer blog. guides Knowledge best suited for Guides size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Oct 27, 2023

mirnawong1 reviewed Oct 27, 2023

View reviewed changes

vercel bot deployed to Preview October 27, 2023 15:52 View deployment

runleonarun requested changes Oct 27, 2023

View reviewed changes

Update website/docs/dbt-cli/cli-overview.md

c46e333

Co-authored-by: Leona B. Campbell <[email protected]>

matthewshaver commented Oct 27, 2023

View reviewed changes

website/docs/guides/advanced/using-jinja.md Outdated Show resolved Hide resolved

matthewshaver and others added 2 commits October 27, 2023 13:03

Update website/docs/guides/advanced/using-jinja.md

82dd70d

Update website/docs/faqs/Runs/checking-logs.md

09e8eb2

Co-authored-by: Leona B. Campbell <[email protected]>

matthewshaver commented Oct 27, 2023

View reviewed changes

website/docs/docs/build/jinja-macros.md Outdated Show resolved Hide resolved

Update website/docs/docs/build/jinja-macros.md

19fbb0b

matthewshaver requested a review from runleonarun October 27, 2023 17:04

runleonarun approved these changes Oct 27, 2023

View reviewed changes

vercel bot deployed to Preview October 27, 2023 17:15 View deployment

Merge branch 'current' into core-cli

bbb7532

matthewshaver enabled auto-merge October 27, 2023 17:33

vercel bot deployed to Preview October 27, 2023 17:40 View deployment

Merge branch 'current' into core-cli

1101f30

vercel bot deployed to Preview October 27, 2023 18:27 View deployment

matthewshaver merged commit 07c622a into current Oct 27, 2023
6 checks passed

matthewshaver deleted the core-cli branch October 27, 2023 18:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update mentions of dbt CLI #4356

Update mentions of dbt CLI #4356

matthewshaver commented Oct 27, 2023

vercel bot commented Oct 27, 2023 •

edited

Loading

mirnawong1 Oct 27, 2023

matthewshaver Oct 27, 2023

runleonarun Oct 27, 2023

runleonarun left a comment

runleonarun Oct 27, 2023

runleonarun Oct 27, 2023

matthewshaver Oct 27, 2023

runleonarun Oct 27, 2023

matthewshaver Oct 27, 2023

runleonarun left a comment

olycats commented Oct 28, 2023

	* Using the dbt Core CLI: Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.
	* Using the dbt Core: Run `dbt compile` from the command line. Then open the compiled SQL file in the `target/compiled/{project name}/` directory. Use a split screen in your code editor to keep both files open at once.

Update mentions of dbt CLI #4356

Update mentions of dbt CLI #4356

Conversation

matthewshaver commented Oct 27, 2023

What are you changing in this pull request and why?

Checklist

vercel bot commented Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

runleonarun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

runleonarun left a comment

Choose a reason for hiding this comment

olycats commented Oct 28, 2023

vercel bot commented Oct 27, 2023 •

edited

Loading