Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adjust docs config page #4529

Merged
merged 7 commits into from
Dec 19, 2023
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After this change, I'd suggest removing this line below so that we're not referring to it back-to-back:

Also refer to [macro properties](/reference/macro-properties).


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

Expand Down
Loading