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.

Sign up for GitHub

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

Update documentation.md #4950

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Update documentation.md #4950

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7975845
Update documentation.md
mirnawong1 Feb 19, 2024
34c660e
Merge branch 'current' into mirnawong1-patch-12
runleonarun Feb 20, 2024
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
3 changes: 1 addition & 2 deletions website/docs/docs/collaborate/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ models:
## Generating project documentation
You can generate a documentation site for your project (with or without descriptions) using the CLI.

First, run `dbt docs generate` — this command tells dbt to compile relevant information about your dbt project and warehouse into `manifest.json` and `catalog.json` files respectively. To see documentation for all columns and not just columns described in your project, ensure that you have created the models with `dbt run` beforehand.
First, run `dbt docs generate` — this command tells dbt to compile relevant information about your dbt project and warehouse into `manifest.json` and `catalog.json` files respectively. To see the documentation for all columns and not just columns described in your project, ensure that you have created the models with `dbt run` beforehand.

Then, run `dbt docs serve` to use these `.json` files to populate a local website.

Expand All @@ -74,7 +74,6 @@ Then, run `dbt docs serve` to use these `.json` files to populate a local websit
<FAQ path="Docs/long-descriptions" />
<FAQ path="Docs/sharing-documentation" />
<FAQ path="Docs/document-other-resources" />
<FAQ path="Project/docs-for-multiple-projects" />


## Using Docs Blocks
Expand Down
Loading