dbt docs serve - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

What does the command dbt docs serve do?

Choose the best description of what dbt docs serve accomplishes in a dbt project.

A It builds the documentation site locally and serves it on a web server for browsing.

B It runs all models and generates a report of data quality issues.

C It deploys the dbt project documentation to a cloud hosting service automatically.

D It cleans the target directory by removing all compiled SQL files.

💡 Hint

Think about what 'serve' usually means in web development.

The dbt docs serve command builds the documentation site from your dbt project and starts a local web server so you can view the docs in your browser.

❓ Predict Output

intermediate

Output of dbt docs serve after successful run

What output will you see in the terminal after running dbt docs serve successfully?

dbt

dbt docs serve

A

Serving docs at http://localhost:8080
Press Ctrl+C to exit

B Error: No profiles.yml found in the project directory

C

Running models...
All models completed successfully

D

Cleaning target directory...
Done

💡 Hint

Look for a message indicating a local web address.

After running dbt docs serve, dbt starts a local web server and shows the URL where you can view the docs.

❓ data_output

advanced

What data is displayed when you open the docs served by dbt docs serve?

Select the correct description of the data shown in the documentation site served by dbt docs serve.

A Only the list of models with their last run timestamps.

B Raw SQL code of all models without any metadata or lineage information.

C A visual catalog of models, sources, tests, and their relationships in the dbt project.

D A summary of database user permissions and access logs.

💡 Hint

Think about what documentation for a data project should include.

The docs site shows a catalog of models, sources, tests, and how they connect, helping users understand the project structure.

🔧 Debug

advanced

Why does dbt docs serve fail with 'No manifest found' error?

You run dbt docs serve but get an error: 'No manifest found. Please run dbt compile or dbt run first.' What is the cause?

A The target database is offline, so docs cannot be served.

B You have not run <code>dbt compile</code> or <code>dbt run</code> to generate the manifest file.

C The <code>dbt docs serve</code> command requires internet connection to download docs.

D Your <code>profiles.yml</code> file is missing or misconfigured.

💡 Hint

The manifest file is created by compiling or running models.

The manifest.json file is needed to build docs. It is created when you run dbt compile or dbt run. Without it, docs cannot be served.

🚀 Application

expert

How to share dbt documentation with your team using dbt docs serve?

You want your team to access the dbt documentation generated by dbt docs serve. Which approach is correct?

A Send the <code>manifest.json</code> file to your team members so they can open it locally.

B Run <code>dbt docs serve</code> on your local machine and share your computer's IP and port with the team.

C Use <code>dbt docs serve</code> with the <code>--public</code> flag to publish docs online automatically.

D Run <code>dbt docs serve</code> on a server accessible by the team, or build static docs with <code>dbt docs generate</code> and host them on a web server.

💡 Hint

Consider how to make docs accessible beyond your local machine.

dbt docs serve runs a local server. To share docs, run it on a shared server or generate static docs with dbt docs generate and host them on a web server.

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