From ce83c677df9bbd708135ecb439b5c901369198b8 Mon Sep 17 00:00:00 2001 From: "Alison (she/her)" Date: Sat, 23 Sep 2023 15:35:39 -0400 Subject: [PATCH 1/3] Update docs.md with more clear node_color info --- website/docs/reference/resource-configs/docs.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index d94b975683d..7017a97000d 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -28,6 +28,7 @@ models: - name: model_name docs: show: true | false + node_color: "black" ``` @@ -119,7 +120,7 @@ macros: ## Definition -The docs field can be used to provide documentation-specific configuration to models. The only currently supported docs attribute is shown, which controls whether or not models are shown in the auto-generated documentation website. +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.” @@ -173,7 +174,7 @@ models: ## Custom node colors -The `docs` attribute now supports `node_color` to customize the node color in the DAG within dbt docs. You can define node colors in the files below and apply overrides where needed. +The `docs` attribute now supports `node_color` to customize the display color of some node types in the DAG within dbt docs. You can define node colors in the files below and apply overrides where needed. `node_color` hiearchy: @@ -182,7 +183,7 @@ The `docs` attribute now supports `node_color` to customize the node color in th ## Examples -Add custom node colors to models within subdirectories based on hex codes or a plain color name. +Add custom `node_colors` to models that support it within subdirectories based on hex codes or a plain color name. ![Example](../../../../website/static/img/node_color_example.png) From 4d1e96fc3b1be4efa394e6ea96deff5675c9e8b3 Mon Sep 17 00:00:00 2001 From: "Alison (she/her)" Date: Sat, 23 Sep 2023 15:45:29 -0400 Subject: [PATCH 2/3] Update docs.md Refer to macro documentation keywords --- website/docs/reference/resource-configs/docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index 7017a97000d..8169b5dc26c 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -114,7 +114,7 @@ macros: ``` - +Also see, [macro properties](reference/macro-properties). From 1dc31117b75a844aa218f80bbc8a57bf9c047170 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 28 Sep 2023 10:49:22 +0100 Subject: [PATCH 3/3] Update website/docs/reference/resource-configs/docs.md --- website/docs/reference/resource-configs/docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/reference/resource-configs/docs.md b/website/docs/reference/resource-configs/docs.md index 4968ed5dc30..0ccd21d7504 100644 --- a/website/docs/reference/resource-configs/docs.md +++ b/website/docs/reference/resource-configs/docs.md @@ -114,7 +114,7 @@ macros: ``` -Also see, [macro properties](reference/macro-properties). +Also refer to [macro properties](/reference/macro-properties).