diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index c5e35dd64f4..d5f7b6499d8 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -20,10 +20,24 @@ default_value: {show: true} - +You can configure `docs` behavior for many resources at once by setting in `dbt_project.yml`. You can also use the `docs` config in `properties.yaml` files, to set or override documentation behaviors for specific resources: + + ```yml +models: + [](/reference/resource-configs/resource-path): + +docs: + show: true | false + +``` + + + + + + ```yml version: 2 models: @@ -32,7 +46,6 @@ models: show: true | false node_color: "black" ``` - @@ -45,6 +58,20 @@ This property is not implemented for sources. +You can use the docs property in YAML files, including the `dbt_project.yml`: + + + +```yml +seeds: + [](/reference/resource-configs/resource-path): + +docs: + show: true | false + +``` + + + ```yml @@ -61,6 +88,20 @@ seeds: +You can use the docs property in YAML files, including the `dbt_project.yml`: + + + +```yml +snapshots: + [](/reference/resource-configs/resource-path): + +docs: + show: true | false + +``` + + + ```yml @@ -77,6 +118,9 @@ snapshots: +You can use the docs property in YAML files, _except_ in `dbt_project.yml`. Refer to [Analysis properties](/reference/analysis-properties) for more info. + + ```yml @@ -93,9 +137,7 @@ analyses: - +You can use the docs property in YAML files, _except_ in `dbt_project.yml`. Refer to [Macro properties](/reference/macro-properties) for more info. @@ -109,8 +151,6 @@ macros: ``` -Also refer to [macro properties](/reference/macro-properties). - @@ -118,7 +158,7 @@ Also refer to [macro properties](/reference/macro-properties). ## Definition The docs field can be used to provide documentation-specific configuration to models. It supports the doc attribute `show`, which controls whether or not models are shown in the auto-generated documentation website. It also supports `node_color` for some node types. -**Note:** hidden models will still appear in the dbt DAG visualization but will be identified as "hidden.” +**Note:** Hidden models will still appear in the dbt DAG visualization but will be identified as "hidden.” ## Default The default value for `show` is `true`.