dbt docs serve - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does the command dbt docs serve do?

It starts a local web server that shows the documentation website for your dbt project, letting you explore models, sources, and tests in a friendly way.

beginner

Before running dbt docs serve, what command should you run to generate the docs?

You should run dbt docs generate to create the documentation files that dbt docs serve will display.

beginner

How can dbt docs serve help you understand your data models better?

It provides a visual and interactive way to see how models relate, their columns, tests, and lineage, making it easier to understand your data flow.

intermediate

Which port does dbt docs serve use by default to show the documentation site?

By default, it uses port 8080, so you can open your browser at http://localhost:8080 to see the docs.

beginner

Can you use dbt docs serve without internet connection?

Yes, because it serves the documentation locally on your machine, no internet is needed once docs are generated.

What is the first step before running dbt docs serve?

A Run <code>dbt docs generate</code>

B Run <code>dbt run</code>

C Run <code>dbt test</code>

D Run <code>dbt seed</code>

You must generate the documentation files first using dbt docs generate before serving them.

Which URL do you open to view docs after running dbt docs serve?

A http://localhost:8080

B http://localhost:3000

C http://127.0.0.1:5000

D http://0.0.0.0:8000

The default port for dbt docs serve is 8080, so you open http://localhost:8080.

What kind of information can you explore in the docs served by dbt docs serve?

A Only SQL code

B Server logs

C Database user permissions

D Models, sources, tests, and lineage

The docs show models, sources, tests, and how data flows between them.

Is an internet connection required to use dbt docs serve after docs are generated?

A Only if you want to update docs

B Yes, it fetches docs from the cloud

C No, it serves docs locally

D Only for the first time

The docs are served locally on your machine, so no internet is needed to view them.

Which command would you use to stop the docs server started by dbt docs serve?

A Close the browser tab

B Press Ctrl+C in the terminal

C Run <code>dbt docs stop</code>

D Run <code>dbt docs kill</code>

You stop the server by pressing Ctrl+C in the terminal where it is running.

Explain the purpose and workflow of using dbt docs serve in a dbt project.

Think about how you prepare and then view your project documentation.

Describe how dbt docs serve helps in understanding data models and their relationships.

Consider what you see when you open the docs site.