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.

Sign up for GitHub

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

Jump to bottom

[Core] Fix content in table for available flags (global configs) #5111

Closed
dbeatty10 opened this issue Mar 19, 2024 · 4 comments · Fixed by #5113
Closed

[Core] Fix content in table for available flags (global configs) #5111

dbeatty10 opened this issue Mar 19, 2024 · 4 comments · Fixed by #5113
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Mar 19, 2024 •
edited
Loading

Link to the page(s) on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/global-configs/about-global-configs#available-flags

Tell us more about this update

Here's what it is currently:

Flag name Type Default Supported in project? Environment variable Command line option Supported in Cloud CLI?
target_path path none ❌ DBT_TARGET_PATH --target-path ❌
profiles_dir path None (current dir, then HOME dir) ❌ DBT_PROFILES_DIR --profiles-dir ❌
target path None (uses target/) ❌ DBT_TARGET --target ❌
profile string None ✅ (as top-level key) DBT_PROFILE --profile ❌

Five things are not accurate:

  1. Default for target_path
  2. Default for target
  3. Type for target
  4. DBT_TARGET won't be available until Add --target and --profile to global config dbt-core#9081 is merged+released
  5. DBT_PROFILE won't be available until Add --target and --profile to global config dbt-core#9081 is merged+released

Here's what it should be instead (until dbt-labs/dbt-core#9081 is merged+released):

Flag name Type Default Supported in project? Environment variable Command line option Supported in Cloud CLI?
target_path path None (uses target/) ❌ DBT_TARGET_PATH --target-path ❌
profiles_dir path None (current dir, then HOME dir) ❌ DBT_PROFILES_DIR --profiles-dir ❌
target path None ❌ --target ❌
profile string None ✅ (as top-level key) --profile ❌

Reviewers/Stakeholders/SMEs

Doug E. Fresh 😎

Related GitHub issues

dbt-labs/dbt-core#9081 (comment)

Additional information

No response
@dbeatty10 dbeatty10 added content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core labels Mar 19, 2024
This was referenced Mar 19, 2024
Merged
Merged
Merged
@jaklan
Copy link

jaklan commented Mar 19, 2024

target also should be string, not path 😉

@dbeatty10
Copy link
Contributor Author

Good catch @jaklan!

Added the fix to this draft PR: f1730c3

@runleonarun
Copy link
Collaborator

Doug E. Fresh 😎

😆 You need to use this all the time now.

dbeatty10 added a commit that referenced this issue Mar 20, 2024
@dbeatty10
Fix default for target and target_path (#5112)
6401151 
[Preview](https://docs-getdbt-com-git-dbeatty10-patch-1-dbt-labs.vercel.app/reference/global-configs/about-global-configs#available-flags)

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

See #5111

These are not accurate:

1. Default for `target_path`
1. Default for `target`
1. Type for `target`

The problem for the first two is that the content is flip-flopped. So
this PR just does that swap.

The problem for the last one is that `target` also should be `string`,
not `path` (as mentioned by
#5111 (comment)).

## 🎩

Here's what it looks like after the fixes in this PR:
<img width="802" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/38ade179-e733-46f4-950a-d1d4db1e325b">

## Checklist
- [x] 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.
dbeatty10 added a commit that referenced this issue Mar 20, 2024
@dbeatty10
Fix environment variables that are not yet available (#5113)
ad96764 
[Preview](https://docs-getdbt-com-git-dbeatty10-patch-2-dbt-labs.vercel.app/reference/global-configs/about-global-configs#available-flags)

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

See #5111

These two things are not accurate:

1. `DBT_TARGET` won't be available until [dbt-core
#9081](dbt-labs/dbt-core#9081) is
merged+released
1. `DBT_PROFILE` won't be available until [dbt-core
#9081](dbt-labs/dbt-core#9081) is
merged+released

So this PR just removes those environment variable names until then.

## 🎩 

After the fix:

<img width="600" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/8ffdf967-604d-4686-ab4b-0e295dfea7a0">

...

<img width="600" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/0e522215-d8be-48ce-bb54-d2568e2e9479">

...

<img width="600" alt="image"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/d58129d0-44c2-481e-a8bb-274fd1276c90">


## To do

- [x] Wait for #5112 to
be merged

## Checklist
- [x] 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.
@dbeatty10
Copy link
Contributor Author

Thanks again @jaklan 🏆

The updates are live here now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix environment variables that are not yet available dbt-labs/docs.getdbt.com
3 participants
@runleonarun @jaklan @dbeatty10