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

Updating notices across docs #4722

merged 28 commits into from
Jan 10, 2024

Conversation

matthewshaver
Copy link
Contributor

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

@matthewshaver matthewshaver requested a review from a team as a code owner January 8, 2024 21:45
Copy link

vercel bot commented Jan 8, 2024

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 Jan 10, 2024 7:37pm

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person and removed Docs team Authored by the Docs team @dbt Labs labels Jan 8, 2024
@github-actions github-actions bot added the Docs team Authored by the Docs team @dbt Labs label Jan 8, 2024
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

Some minor suggestions. Mostly "hell yeahs"

@@ -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!

@@ -1,5 +0,0 @@
:::important Upgrade Guides Are Moving

Copy link
Collaborator

Choose a reason for hiding this comment

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

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we can even remove this line and add "preferred" in the example title?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Works for me!

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

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)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can use the lifecycle status here as well

Suggested change
### Require a specific dbt version (not recommended)
### Require a specific dbt version <Lifecycle status='Not recommended' />

matthewshaver and others added 2 commits January 9, 2024 09:27
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>
Copy link
Contributor

@nghi-ly nghi-ly left a comment

Choose a reason for hiding this comment

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

tysm for doing this maintenance work! incredible. left some feedback for ya

website/docs/faqs/Accounts/cloud-upgrade-instructions.md Outdated Show resolved Hide resolved
website/docs/guides/bigquery-qs.md Show resolved Hide resolved
website/docs/guides/databricks-qs.md Show resolved Hide resolved
website/docs/guides/debug-schema-names.md Outdated Show resolved Hide resolved
website/docs/reference/resource-configs/delimiter.md Outdated Show resolved Hide resolved

:::
If you're using BigQuery, use the _project_ name as the `database:` property.
Copy link
Contributor

Choose a reason for hiding this comment

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

nice cleanup!

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

this section is duplicated.

list is ordered alphabetically, should be after "Extended attributes" section.

here's the page TOC from vercel preview :

Screenshot 2024-01-09 at 2 11 23 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.
:::
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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?

Copy link
Contributor

@mirnawong1 mirnawong1 Jan 10, 2024

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

matthewshaver and others added 2 commits January 10, 2024 11:37
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com>
matthewshaver and others added 11 commits January 10, 2024 11:58
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>
Copy link
Contributor

@nghi-ly nghi-ly left a comment

Choose a reason for hiding this comment

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

lgtm!

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

lgtm!

@matthewshaver matthewshaver merged commit 6b3fde3 into current Jan 10, 2024
7 checks passed
@matthewshaver matthewshaver deleted the notices branch January 10, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides January-2024 size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants