dbt-labs / dbt-labs/docs.getdbt.com

[Core] Include project flag, environment variable, and CLI flag on a per config basis

Open
#5,637 0 comments 0 reactions 0 assignees View on GitHub
content dbt Core size: medium
Dominant language
JavaScript
Stars
215
Forks
1.2k
Avg merge
1d 15h
Merged PRs (30d)
130

Description

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

Each page for a global config like [`printer_width`](https://docs.getdbt.com/reference/global-configs/print-output#printer-width), [`warn_error_options`](https://docs.getdbt.com/reference/global-configs/warnings), etc.

https://github.com/dbt-labs/docs.getdbt.com/issues/5636

### Tell us more about this update

[This](https://docs.getdbt.com/reference/global-configs/about-global-configs) page has a table of all global configs and their associated project flag, environment variable, and CLI flag.

This is very helpful to see every possible config at a glance. But if a user wants to know the configuration locations and names for a _particular_ config ([`printer_width`](https://docs.getdbt.com/reference/global-configs/print-output#printer-width)), they would need to know to go to that summary table.

It would be great if the [`printer_width`](https://docs.getdbt.com/reference/global-configs/print-output#printer-width) page had a summary table like this:

image

### Reviewers/Stakeholders/SMEs

[Dougie B.](https://github.com/dbeatty10)

### Related GitHub issues

Came up most recently here:
- https://github.com/dbt-labs/dbt-core/pull/9081#issuecomment-2144183788
- https://github.com/dbt-labs/dbt-core/pull/9081#issuecomment-2145329904

### Additional information

Related to https://github.com/dbt-labs/docs.getdbt.com/issues/5636

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the About global configs page and its summary table, then compare the printer_width and warn_error_options pages named in the issue. Identify the documentation source pages corresponding to the global configs and add the project, environment-variable, and CLI names to each relevant page. Done means each config page exposes the same configuration-location details as the summary table.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.