Skip to content

Commit

Permalink
adjust docs config page
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 committed Nov 22, 2023
1 parent c392a21 commit 3c32c92
Showing 1 changed file with 47 additions and 3 deletions.
50 changes: 47 additions & 3 deletions website/docs/reference/resource-configs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ default_value: {show: true}

<TabItem value="models">

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:


<File name='models/schema.yml'>


Expand All @@ -35,6 +38,18 @@ models:
</File>
<File name='dbt_project.yml'>
```yml
models:
[<resource-path>](/reference/resource-configs/resource-path):
+docs:
show: true | false

```

</File>

</TabItem>

<TabItem value="sources">
Expand All @@ -45,6 +60,20 @@ This property is not implemented for sources.

<TabItem value="seeds">

You can use the docs property in YAML files, including the `dbt_project.yml`:

<File name='dbt_project.yml'>

```yml
seeds:
[<resource-path>](/reference/resource-configs/resource-path):
+docs:
show: true | false

```

</File>

<File name='seeds/schema.yml'>

```yml
Expand All @@ -61,6 +90,20 @@ seeds:
<TabItem value="snapshots">
You can use the docs property in YAML files, including the `dbt_project.yml`:

<File name='dbt_project.yml'>

```yml
snapshots:
[<resource-path>](/reference/resource-configs/resource-path):
+docs:
show: true | false
```

</File>

<File name='snapshots/schema.yml'>

```yml
Expand All @@ -77,6 +120,9 @@ snapshots:

<TabItem value="analyses">

You can use the docs property in YAML files, _except_ in `dbt_project.yml`. Refer to [Analysis properties](/reference/analysis-properties) for more info.


<File name='analysis/schema.yml'>

```yml
Expand All @@ -93,9 +139,7 @@ analyses:

<TabItem value="macros">

<!----
To-do: check this
--->
You can use the docs property in YAML files, _except_ in `dbt_project.yml`. Refer to [Macro properties](/reference/macro-properties) for more info.

<File name='macros/schema.yml'>

Expand Down

0 comments on commit 3c32c92

Please sign in to comment.