From 3c32c92c0b55c6fbfdcb1af06f151ee54ed180c6 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 22 Nov 2023 07:32:41 -0500 Subject: [PATCH] adjust docs config page --- .../docs/reference/resource-configs/docs.md | 50 +++++++++++++++++-- 1 file changed, 47 insertions(+), 3 deletions(-) diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index c5e35dd64f4..b188753010f 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -20,6 +20,9 @@ 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: + + @@ -35,6 +38,18 @@ models: + + +```yml +models: + [](/reference/resource-configs/resource-path): + +docs: + show: true | false + +``` + + + @@ -45,6 +60,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 +90,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 +120,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 +139,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.