Generating documentation site in dbt - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of generating a documentation site in dbt?

Generating a documentation site in dbt helps you create a clear, easy-to-navigate website that shows your data models, sources, and tests. It helps teams understand the data pipeline better.

beginner

Which dbt command is used to generate the documentation site?

The command dbt docs generate creates the documentation files needed for the site.

beginner

How do you view the generated documentation site locally?

After generating docs, run dbt docs serve to start a local web server. Then open the provided URL in your browser to explore the docs.

intermediate

What kind of information can you find in the dbt documentation site?

You can find model descriptions, column details, data sources, test results, and lineage graphs showing how data flows between models.

beginner

Why is it important to add descriptions to models and columns in dbt before generating docs?

Descriptions make the documentation site more useful by explaining what each model and column means, helping everyone understand the data better.

Which command generates the documentation files in dbt?

A dbt docs generate

B dbt run

C dbt test

D dbt compile

The dbt docs generate command creates the files needed for the documentation site.

How do you start a local server to view dbt docs?

A dbt test

B dbt run

C dbt build

D dbt docs serve

Use dbt docs serve to start a local web server for viewing the documentation site.

What does the dbt documentation site NOT show?

A Data lineage graphs

B Column details

C Raw data records

D Data model descriptions

The documentation site shows metadata and lineage, but not the actual raw data records.

Why should you add descriptions to your dbt models before generating docs?

A To speed up dbt runs

B To improve documentation clarity

C To reduce data size

D To create tests automatically

Descriptions help make the documentation clearer and more useful for everyone.

Which of these is a benefit of using the dbt documentation site?

A Helps teams understand data flow

B Automatically fixes data errors

C Runs SQL queries faster

D Stores raw data securely

The documentation site helps teams see how data moves and is transformed, improving understanding.

Explain the steps to generate and view a dbt documentation site.

Think about commands and how to access the site.

Describe why adding descriptions to models and columns is important before generating docs in dbt.

Consider how documentation helps people.

Practice

1. What does the command dbt docs generate do in a dbt project?

easy

A. It deletes old documentation files from your project folder.

B. It runs all your data transformations and loads data into the warehouse.

C. It starts a local server to view your documentation site.

D. It creates a website with documentation for your data models and sources.

Solution

1. Step 1: Understand the purpose of dbt docs generate

   This command builds the documentation files for your dbt project, including models and sources.

2. Step 2: Differentiate from other commands

   Unlike dbt run which runs transformations or dbt docs serve which serves the docs, dbt docs generate only creates the documentation files.

3. Final Answer:

   It creates a website with documentation for your data models and sources. -> Option D

4. Quick Check:

   dbt docs generate builds docs [OK]

Hint: Generate docs builds files; serve shows them [OK]

Common Mistakes:

• Confusing generate with run or serve commands
• Thinking it runs data transformations
• Assuming it deletes files

2. Which of the following is the correct command to view the generated documentation site locally?

easy

A. dbt docs view

B. dbt docs generate

C. dbt docs serve

D. dbt docs start

Solution

1. Step 1: Identify the command to serve docs

   The command dbt docs serve starts a local web server to view the generated documentation site.

2. Step 2: Confirm other options are incorrect

   dbt docs generate only creates docs files, while dbt docs view and dbt docs start are not valid dbt commands.

3. Final Answer:

   dbt docs serve -> Option C

4. Quick Check:

   Serve command shows docs locally [OK]

Hint: Serve command launches docs site locally [OK]

Common Mistakes:

• Using generate instead of serve to view docs
• Typing invalid commands like docs view or docs start
• Confusing generate and serve commands

3. Given the following commands run in order:

dbt docs generate
dbt docs serve

What will happen after running these commands?

medium

A. The documentation site is created and then opened in a local web browser.

B. The data models are rebuilt and the docs site is deleted.

C. Only the documentation files are created but not viewable.

D. An error occurs because docs serve must run before docs generate.

Solution

1. Step 1: Understand the effect of dbt docs generate

   This command creates the documentation files needed for the docs site.

2. Step 2: Understand the effect of dbt docs serve

   This command starts a local server and opens the docs site in a browser using the generated files.

3. Final Answer:

   The documentation site is created and then opened in a local web browser. -> Option A

4. Quick Check:

   Generate then serve shows docs [OK]

Hint: Generate first, then serve to view docs [OK]

Common Mistakes:

• Thinking docs serve deletes docs
• Believing docs serve must run before generate
• Assuming docs generate runs data models

4. You ran dbt docs serve but the documentation site does not open in your browser. What is the most likely cause?

medium

A. You need to run dbt run before serving docs.

B. You forgot to run dbt docs generate first to create the docs files.

C. The dbt docs serve command requires an internet connection.

D. Your dbt project has no models defined.

Solution

1. Step 1: Check prerequisites for serving docs

   The dbt docs serve command needs the documentation files created by dbt docs generate.

2. Step 2: Identify missing step

   If dbt docs generate was not run, the docs files don't exist, so the site won't open.

3. Final Answer:

   You forgot to run dbt docs generate first to create the docs files. -> Option B

4. Quick Check:

   Generate docs before serving [OK]

Hint: Always generate docs before serving [OK]

Common Mistakes:

• Assuming docs serve works without generated files
• Thinking internet is required for docs serve
• Believing dbt run affects docs serving

5. You want to share your dbt project's documentation site with your team without running dbt docs serve locally. Which approach is best?

hard

A. Generate the docs with dbt docs generate and upload the generated files to a web server.

B. Run dbt docs serve and share your local IP address with the team.

C. Send your team the dbt_project.yml file to generate docs themselves.

D. Use dbt run to automatically publish docs online.

Solution

1. Step 1: Understand how docs are generated and shared

   dbt docs generate creates static documentation files that can be hosted anywhere.

2. Step 2: Identify best way to share without local serving

   Uploading generated docs to a web server allows team members to access the docs anytime without running commands locally.

3. Final Answer:

   Generate the docs with dbt docs generate and upload the generated files to a web server. -> Option A

4. Quick Check:

   Upload generated docs for team access [OK]

Hint: Upload generated docs files to share site [OK]

Common Mistakes:

• Sharing local IP which may not be accessible
• Sending config files instead of docs
• Thinking dbt run publishes docs automatically