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

Project flags, for global config defaults + behavior change migrations #4814

Merged
merged 42 commits into from
Feb 27, 2024

Conversation

jtcohen6
Copy link
Collaborator

@jtcohen6 jtcohen6 commented Jan 29, 2024

resolves #4366
resolves #4709
resolves #4787
resolves #2894

What are you changing in this pull request and why?

  • Reframe "global configs" → "flags"
  • Settable in dbt_project.yml instead of profiles.yml
  • Subcategory of flags for legacy behaviors / behavior change migrations

Previews

Most important changes:

Other new pages:

Other significant edits:

Edited links:

Deleted:

  • website/docs/reference/global-cli-flags.md
  • website/docs/reference/global-configs/yaml-configurations.md
  • website/docs/reference/project-configs/log-path.md
  • website/docs/reference/project-configs/target-path.md

Minor edits (moved and re-titled):

  • website/docs/reference/global-configs/command-line-options.md

Other:

  • .github/pull_request_template.md

Checklist

Adding or removing pages (delete if not applicable):

  • Add/remove page in website/sidebars.js
  • Provide a unique filename for new pages
  • Add an entry for deleted pages in website/vercel.json
  • Run link testing locally with npm run build to update the links that point to deleted pages

Copy link

vercel bot commented Jan 29, 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 Feb 27, 2024 6:36pm

@github-actions github-actions bot added content Improvements or additions to content size: large This change will more than a week to address and might require more than one person labels Jan 29, 2024
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

You are a tour de force 🤩

Didn't look at any previews yet, but read through the code and left some comments below.

Something we should consider handling either within this PR or a separate one: #4366

See #4366 (comment) for one idea to tie together CLI flags and environment variable names. Unfortunately, it wouldn't also tie together flag settings within dbt_project.yml too.

Copy link
Collaborator Author

@jtcohen6 jtcohen6 left a comment

Choose a reason for hiding this comment

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

Something we should consider handling either within this PR or a separate one: #4366

I gave it a go! It's not the prettiest, but I stand by the information in there. Let me know what you think.

https://docs-getdbt-7fp98qtm3-dbt-labs.vercel.app/reference/global-configs/about-global-configs#available-flags

@runleonarun
Copy link
Collaborator

runleonarun commented Feb 22, 2024

@matthewshaver will review this on Thursday. Thanks for all the work Doug and Jerco!

## What are you changing in this pull request and why?

Updates the profiles.yml page to reflect the changes to global configs

## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/static/_redirects`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
resolves #4773 

## What are you changing in this pull request and why?
<!---
Describe your changes and why you're making them. If related to an open 
issue or a pull request on dbt Core, then link to them here! 

To learn more about the writing conventions used in the dbt Labs docs,
see the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md).
-->

## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/static/_redirects`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
Fixing spacing
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

This has such great info! 🧠

5 non-blocking comments -- any can be converted to fast-follows.

  • (3) small suggestions
  • (2) fast-follow nudges

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 February-2024 size: large This change will more than a week to address and might require more than one person
Projects
None yet
4 participants