Table of configs, command-line flags, and environment variables

[dbeatty10]

Contributions

• I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

This could affect multiple pages:

• https://docs.getdbt.com/reference/profiles.yml
• https://docs.getdbt.com/reference/global-configs
• https://docs.getdbt.com/reference/global-cli-flags
• https://docs.getdbt.com/docs/build/environment-variables
• https://docs.getdbt.com/reference/dbt-jinja-functions/flags (See Additional information)

What part(s) of the page would you like to see updated?

The main problem to solve is that as a user, it's not easy for me to see the levers I can pull to elicit various behavior. e.g.

• What can I configure?
• Which command-line flags can I use?
• Which environment variables?
• How do all of these options correspond to each other?

We've made some great progress with the click-based CLI (that will come out in dbt Core 1.5) -- maybe we can tie into its capabilities in combination with Sphinx docs generation?

I'd love to see a page with a table similar to this (but exhaustive in terms of its scope):

Additional information

This page should also be reviewed:

• https://docs.getdbt.com/reference/dbt-jinja-functions/flags

Specifically, the part where it says:

The list of available flags is defined in the flags module within dbt-core.

[dbeatty10]

Here's an example where I would have liked to link to the relevant listing of environment variables:
dbt-labs/dbt-core#7518 (comment)

[dbeatty10]

Resolved by #4814