dbt-labs / docs.getdbt.com

The code behind docs.getdbt.com
https://docs.getdbt.com/
Apache License 2.0
118 stars 928 forks source link

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

Open dbeatty10 opened 3 months ago

dbeatty10 commented 3 months ago

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

Each page for a global config like printer_width, warn_error_options, etc.

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

Tell us more about this update

This 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), they would need to know to go to that summary table.

It would be great if the printer_width page had a summary table like this:

image

Reviewers/Stakeholders/SMEs

Dougie B.

Related GitHub issues

Came up most recently here:

Additional information

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