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.