Skip to content

Commit 53cbc21

Browse files
committed
clarify readme
1 parent 11b6203 commit 53cbc21

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# dbt-docs-to-notion
22

3-
A Github action for exporting dbt model docs to a Notion database, where they can be conveniently consumed (especially by casual users in your org).
3+
A Github action for exporting dbt docs to a Notion database, where they can be conveniently consumed (especially by casual users in your org).
44

55
## Output
66

7-
A Notion database, within a parent page of your choosing, with records like this:
7+
A Notion database, within a parent page of your choosing, with records like this for each model that contain the same information as dbt docs:
88
![dbt docs to notion output](https://i.imgur.com/Y1EWj9l.png)
99

1010
## Usage
@@ -14,7 +14,12 @@ A Notion database, within a parent page of your choosing, with records like this
1414
In advance of using this action, you should:
1515

1616
1. [Create a new integration within your Notion workspace](https://www.notion.so/my-integrations)
17-
2. Have your Notion integration token and a working dbt `profiles.yml` accessible to your repo (I'd recommend using [Github's repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets); see example workflow below).
17+
2. Create a parent Notion page for the docs database and share it with the integration from above
18+
3. Have your Notion integration token and a working dbt `profiles.yml` accessible to your repo (I'd recommend using [Github's repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets); see example workflow below).
19+
20+
Ideally you should also write descriptions for models and columns as is a [best practice](https://docs.getdbt.com/docs/building-a-dbt-project/documentation#adding-descriptions-to-your-project).
21+
22+
> ❗️ Note: this program assumes schema-defined model and column names to be entirely lowercase.
1823
1924
### Inputs
2025

0 commit comments

Comments
 (0)