Updating notices across docs #4722
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
| @@ -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 | |||
|
|
|||
There was a problem hiding this comment.
Good call moving these!
| @@ -1,5 +0,0 @@ | |||
| :::important Upgrade Guides Are Moving | |||
|
|
|||
There was a problem hiding this comment.
Good catch! I forgot about this one!
| @@ -1,6 +1,8 @@ | |||
|
|
|||
| Every [dbt project](/docs/build/projects) needs a `dbt_project.yml` file — this is how dbt knows a directory is a dbt project. It also contains important information that tells dbt how to operate your project. | |||
|
|
|||
| dbt uses YAML in a few different places. If you're new to YAML, it would be worth taking the time to learn how arrays, dictionaries, and strings are represented. | |||
There was a problem hiding this comment.
Is there a link we can send people to for learning YAML?? I found these: https://www.redhat.com/sysadmin/yaml-beginners or https://www.w3schools.io/file/yaml-introduction/
| ### Remove packages and compiled files as part of `dbt clean` | ||
| :::info | ||
|
|
||
| This is our preferred configuration, but is not the default. |
There was a problem hiding this comment.
Maybe we can even remove this line and add "preferred" in the example title?
website/docs/guides/how-to-use-databricks-workflows-to-run-dbt-cloud-jobs.md
Show resolved
Hide resolved
website/docs/guides/how-to-use-databricks-workflows-to-run-dbt-cloud-jobs.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
thanks @matthewshaver and nice work here! a lot to parse and you can tell you really took into consideration how to make some callouts part of the text. i left some feedback on a couple of files and think there are use cases for callouts in some instances, particularly if we want to highlight something important to users that might otherwise get absorbed in the text.
| :::caution Not recommended | ||
| With the release of major version 1.0 of dbt Core, pinning to a specific patch is discouraged. | ||
| ::: | ||
| ### Require a specific dbt version (not recommended) |
There was a problem hiding this comment.
We can use the lifecycle status here as well
| ### Require a specific dbt version (not recommended) | |
| ### Require a specific dbt version <Lifecycle status='Not recommended' /> |
Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com>
Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com>
Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com>
|
|
||
| ::: | ||
| If you're using BigQuery, use the _project_ name as the `database:` property. |
| @@ -28,11 +28,33 @@ Both development and deployment environments have a section called **General Set | |||
| | Default to Custom Branch | ☑️ | Determines whether to use a branch other than the repository’s default | See below | | |||
| | Custom Branch | dev | Custom Branch name | See below | | |||
|
|
|||
| :::note About dbt version | |||
| ### About versions in dbt Cloud | |||
There was a problem hiding this comment.
love this idea of a new section!
i'm a little familiar with this content. sugg :
- make it an H2 instead of an H3
- move this new section to a higher location on the page, above the "Common environment settings" H2 section
| - Automatic updates: Selecting a version labeled `(latest)` ensures your environment automatically installs the latest stable release of that minor version selected. | ||
|
|
||
|
|
||
| ### Git repository caching |
There was a problem hiding this comment.
this section is duplicated.
list is ordered alphabetically, should be after "Extended attributes" section.
here's the page TOC from vercel preview :
There was a problem hiding this comment.
Going to revert this whole file. Something funky happened with the additions here that weren't supposed to.
|
|
||
| ### Git repository caching | ||
| :::info Available for dbt Cloud Enterprise plans | ||
| This feature is exclusively available for dbt Cloud Enterprise plans. [Book a demo](https://www.getdbt.com/contact) to learn more. | ||
| ::: |
There was a problem hiding this comment.
sugg moving this callout to the end of the section. i've been taught that a callout after a title is not "good design" practice
There was a problem hiding this comment.
We do this in numerous places. I thought the idea was to give the important info at the top of the article, rather than at the tail end, especially if the feature is not available to a subset of users.
@runleonarun and @mirnawong1 thoughts on this?
There was a problem hiding this comment.
this is a great question and all great points! i would prefer having the callout out at the top of the content:
- we do this already in pretty much all our docs so adding it at the end would be more of an antipattern.
- i think having at the top sets clear expectations and also hopefully perks interests.
- when i first read this, i thought this was for all plans and then was surprised it was for enterprise. i almost missed the callout, in fact. so i do prefer it to be at the top.
- also if we do the lifecycle pill, that will be in the header so it'll be above the content/article anyway
There was a problem hiding this comment.
yeah, we have prior art for both.
i like to talk about the cool thing first instead of dropping caveats/limitations at the top. not a big deal tho. non-blocker for me.
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
…-cloud-jobs.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
What are you changing in this pull request and why?
Deletes and otherwise alters older notices that are no longer needed, past their due date, or otherwise deprecated
Checklist