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

Consistent descriptions of precedence order

Open
#4,371 1 comment 1 reaction 0 assignees View on GitHub
content improvement
Dominant language
JavaScript
Stars
215
Forks
1.2k
Avg merge
1d 15h
Merged PRs (30d)
130

Description

### Contributions

- [X] I have read the contribution docs, and understand what's expected of me.

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

Lots of pages! See below.

As noted within https://github.com/dbt-labs/docs.getdbt.com/issues/4362:

### Listings of precedence

Here are some concepts in dbt that list their precedence order:
- [Global config precedence](https://docs.getdbt.com/reference/global-configs/about-global-configs#setting-flags) (formerly [here](https://docs.getdbt.com/reference/global-configs/about-global-configs#global-config-precedence))
- [Materialization precedence](https://docs.getdbt.com/guides/create-new-materializations?step=4)
- [Variable precedence](https://docs.getdbt.com/docs/build/project-variables#variable-precedence)
- [Customizing a profile directory](https://docs.getdbt.com/docs/local/profiles.yml#location-of-profilesyml) (formerly [here](https://docs.getdbt.com/docs/core/connect-data-platform/connection-profiles#advanced-customizing-a-profile-directory))
- [Customizing a state artifact directory as output](https://docs.getdbt.com/reference/global-configs/json-artifacts#target-path) (formerly [here](https://docs.getdbt.com/reference/project-configs/target-path#configuration))
- [Using a state artifact directory as input](https://docs.getdbt.com/reference/node-selection/configure-state) (formerly [here](https://docs.getdbt.com/reference/node-selection/syntax#establishing-state))
- [Setting and overriding environment variables: Order of precedence](https://docs.getdbt.com/docs/build/environment-variables#setting-and-overriding-environment-variables)
- [Model config inheritance: hierarchical precedence](https://docs.getdbt.com/reference/model-configs#configuring-models)
- [Config inheritance: hierarchical precedence](https://docs.getdbt.com/reference/define-configs#config-inheritance) (formerly [here](https://docs.getdbt.com/reference/configs-and-properties#config-inheritance))
- [Snapshot config inheritance: hierarchical precedence](https://docs.getdbt.com/reference/snapshot-configs#configuring-snapshots)
- [Multiple dispatch: For database adapter maintainers](https://docs.getdbt.com/reference/dbt-jinja-functions/dispatch#for-adapter-plugin-maintainers)
- [Multiple dispatch: For package maintainers](https://docs.getdbt.com/reference/dbt-jinja-functions/dispatch#for-package-maintainers)
- [`node_color` in docs](https://docs.getdbt.com/reference/resource-configs/docs#custom-node-colors)
- [`loaded_at_field ` in docs](https://docs.getdbt.com/reference/resource-properties/freshness#definition)
- [materializing database objects](https://docs.getdbt.com/reference/resource-configs/materialized#creation-precedence)

Some missing orders of precedence:
- Resolution order for [ref](https://docs.getdbt.com/reference/dbt-jinja-functions/ref) when there are multiple packages with the same model name ([dbt-core #8954](https://github.com/dbt-labs/dbt-core/issues/8954))
- [Macro precedence](https://stackoverflow.com/a/75551526) ("I believe this precedence applies for all macros and not just materializations.")
- disabling a package model, seed, etc and replacing it (see [here](https://github.com/dbt-labs/docs.getdbt.com/issues/5094) and [here](https://github.com/dbt-labs/dbt-core/issues/12243#issuecomment-4008125213) and [here](https://github.com/dbt-labs/docs.getdbt.com/issues/8724))

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

It would be good to review all of the pages above for uniformity of verbiage, ordering, and visual layout.

In order to be best understood, they should be ordered in the same way, use the same phrases, and look similar.

### Additional information

See here for the example that prompted this issue:
https://github.com/dbt-labs/docs.getdbt.com/pull/4363

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.