dbt docs serve - Mini Project: Build & Apply

Serving dbt Documentation Locally

📖 Scenario: You are working on a data analytics project using dbt (data build tool). You want to generate and serve the project documentation locally so you can explore your data models and their relationships in a web browser.

🎯 Goal: Learn how to use the dbt docs serve command to generate and serve your dbt project documentation locally.

📋 What You'll Learn

Have a dbt project initialized with some models

Have dbt installed and configured

Use the dbt docs serve command to serve documentation

💡 Why This Matters

🌍 Real World

Data analysts and engineers use dbt docs serve to quickly view and understand their data models and lineage during development.

💼 Career

Knowing how to generate and serve dbt documentation is essential for data professionals working with dbt to maintain clear, accessible data pipelines.

1

Generate dbt Documentation

Run the command dbt docs generate in your terminal to create the documentation files for your dbt project.

dbt

# Run the command to generate dbt docs
# Your code here

Hint

This command creates the documentation files needed to serve your dbt docs.

2

Serve the Documentation Locally

Run the command dbt docs serve in your terminal to start a local web server that hosts your dbt documentation.

dbt

# Run the command to serve dbt docs
# Your code here

Hint

This command starts a local server and opens your default browser to view the docs.

3

Access the Documentation in Browser

After running dbt docs serve, open your web browser and go to http://localhost:8080 to view your dbt project documentation.

dbt

# Open your browser at http://localhost:8080 to view docs
# Your code here

Hint

The documentation is served on port 8080 by default.

4

Confirm Documentation is Served

Print the message 'Documentation is now served at http://localhost:8080' to confirm that the dbt docs are available locally.

dbt

# Print confirmation message
# Your code here

Hint

This message confirms your docs are ready to explore.

Practice

1. What is the main purpose of the dbt docs serve command?

easy

A. To deploy your project to the cloud

B. To run your data models and create tables

C. To display your data project documentation in a web browser

D. To test your SQL queries for errors

Solution

1. Step 1: Understand the command's function

   dbt docs serve is used to show documentation, not to run models or deploy.

2. Step 2: Match the command to its purpose

   It opens a web browser with your project's docs, helping you explore models and their relationships.

3. Final Answer:

   To display your data project documentation in a web browser -> Option C

4. Quick Check:

   dbt docs serve = show docs [OK]

Hint: Remember: 'serve' means show docs in browser [OK]

Common Mistakes:

• Confusing docs serve with model run commands
• Thinking it deploys or tests code
• Assuming it updates models automatically

2. Which of the following is the correct way to start the documentation server in dbt?

easy

A. dbt docs build

B. dbt docs serve

C. dbt run docs

D. dbt serve docs

Solution

1. Step 1: Recall the exact command syntax

   The command to start the docs server is dbt docs serve.

2. Step 2: Eliminate incorrect options

   dbt docs build builds docs but does not serve; others are invalid syntax.

3. Final Answer:

   dbt docs serve -> Option B

4. Quick Check:

   Serve docs = dbt docs serve [OK]

Hint: Serve means start server; docs serve is correct [OK]

Common Mistakes:

• Using docs build instead of docs serve
• Swapping command order incorrectly
• Typing commands that don't exist

3. Consider this sequence of commands run in a dbt project:

dbt docs build
dbt docs serve

What will happen after running dbt docs serve?

medium

A. Nothing happens because docs serve only works with dbt cloud

B. The project models are rebuilt and deployed

C. An error occurs because docs build must be run after docs serve

D. A web browser opens showing the latest project documentation

Solution

1. Step 1: Understand the commands order

   dbt docs build creates the documentation files; dbt docs serve opens them in a browser.

2. Step 2: Predict the result of docs serve

   Since docs are built, docs serve will open a browser showing the docs.

3. Final Answer:

   A web browser opens showing the latest project documentation -> Option D

4. Quick Check:

   Build then serve = open docs [OK]

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

Common Mistakes:

• Thinking docs serve rebuilds models
• Believing docs serve causes errors without cloud
• Confusing docs build and run commands

4. You ran dbt docs serve but the browser does not open automatically. What is the most likely cause?

medium

A. You forgot to run dbt docs build first

B. Your dbt project has syntax errors

C. The command <code>dbt docs served

D. Your internet connection is down

Solution

1. Step 1: Check prerequisites for docs serve

   dbt docs serve requires docs to be built first with dbt docs build.

2. Step 2: Identify the cause of no browser opening

   If docs are not built, serve has no files to show, so browser won't open.

3. Final Answer:

   You forgot to run dbt docs build first -> Option A

4. Quick Check:

   Build docs before serve [OK]

Hint: Always build docs before serving [OK]

Common Mistakes:

• Assuming syntax errors block docs serve
• Thinking internet is needed for local docs
• Misspelling command but not checking

5. You want to share your dbt project's documentation with a teammate who is not on your local machine. Which approach using dbt docs serve is best?

hard

A. Run dbt docs serve --host 0.0.0.0 to allow external access on your network

B. Run dbt docs serve and share the local URL shown in the terminal

C. Run dbt docs build, then upload the generated docs site to a shared web server

D. Send your teammate the dbt_project.yml file to build docs themselves

Solution

1. Step 1: Understand default behavior of docs serve

   By default, dbt docs serve binds to localhost, so only your machine can access it.

2. Step 2: Enable external access

   Using --host 0.0.0.0 allows other devices on your network to access the docs server.

3. Step 3: Compare options

   Sharing local URL won't work externally; uploading docs is possible but outside docs serve; sending config file is indirect.

4. Final Answer:

   Run dbt docs serve --host 0.0.0.0 to allow external access on your network -> Option A

5. Quick Check:

   Serve with host 0.0.0.0 = share docs externally [OK]

Hint: Use --host 0.0.0.0 to share docs on network [OK]

Common Mistakes:

• Sharing localhost URL expecting remote access
• Not knowing how to expose server externally
• Confusing config files with docs content