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.