Generating documentation site in dbt - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

What does the command `dbt docs generate` do?

In dbt, what is the main purpose of running the command dbt docs generate?

A It creates a static website with documentation about your dbt models and their relationships.

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

C It deletes all existing documentation files from your project.

D It installs dbt packages required for your project.

💡 Hint

Think about what kind of output you want to see after running dbt docs generate.

The dbt docs generate command creates a static documentation site that shows your models, their columns, and how they relate. It does not run models or install packages.

❓ Predict Output

intermediate

Output of `dbt docs serve` after generating docs

After running dbt docs generate, you run dbt docs serve. What happens next?

A It uploads the documentation to a remote server automatically.

B dbt runs all models and shows their run status in the terminal.

C A local web server starts and opens a browser showing the documentation site.

D The command fails because docs were not generated yet.

💡 Hint

Consider what serve usually means for documentation tools.

dbt docs serve starts a local web server that lets you view the documentation generated by dbt docs generate in your browser.

❓ data_output

advanced

What data is included in the generated documentation site?

Which of the following data is included in the documentation site generated by dbt docs generate?

A User credentials and connection details.

B Raw data from your warehouse tables.

C Only the SQL code of your models without any metadata.

D Model names, descriptions, columns, tests, and lineage graph.

💡 Hint

Think about what information helps you understand your models and their relationships.

The documentation site includes metadata like model names, descriptions, columns, tests, and a graph showing how models depend on each other. It does not include raw data or sensitive info.

🔧 Debug

advanced

Why does `dbt docs serve` fail after `dbt docs generate`?

You ran dbt docs generate but when you run dbt docs serve, it fails with an error saying documentation files are missing. What is the most likely cause?

A You ran <code>dbt docs generate</code> in a different project directory than where you ran <code>dbt docs serve</code>.

B You forgot to install dbt before running the commands.

C Your dbt version is too new and does not support docs commands.

D You need to run <code>dbt run</code> before generating docs.

💡 Hint

Think about where the documentation files are saved and where you run commands.

The docs files are saved in the target directory of the project where dbt docs generate was run. Running dbt docs serve in a different directory will not find these files.

🚀 Application

expert

How to customize documentation descriptions for models and columns?

You want to add clear descriptions to your dbt models and columns so they appear in the generated documentation site. Which file do you edit to add these descriptions?

A The SQL model files by adding comments inside the SELECT statements.

B The <code>schema.yml</code> file where you define models and columns with descriptions.

C The <code>dbt_project.yml</code> file to add descriptions globally.

D The <code>profiles.yml</code> file to configure descriptions.

💡 Hint

Think about where dbt stores metadata about models and columns.

Descriptions for models and columns are added in schema.yml files using YAML syntax. These descriptions then appear in the documentation site.

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