Generating documentation site in dbt - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to generate the dbt documentation site.

dbt

dbt [1] generate

Drag options to blanks, or click blank then click option'

Adocs

Bbuild

Crun

Dtest

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'dbt run' instead of 'dbt docs generate'.

Using 'dbt test' which runs tests, not docs.

The command 'dbt docs generate' is used to generate the documentation site.

2fill in blank

medium

Complete the code to serve the generated dbt documentation site locally.

dbt

dbt docs [1]

Drag options to blanks, or click blank then click option'

Agenerate

Bbuild

Cserve

Drun

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'dbt docs generate' which only generates files.

Using 'dbt run' which runs models, not docs.

The command 'dbt docs serve' starts a local server to view the docs.

3fill in blank

hard

Fix the error in the command to generate documentation site.

dbt

dbt docs [1]

Drag options to blanks, or click blank then click option'

Aserve

Bdocs

Crun

Dgenerate

Attempts:

3 left

💡 Hint

Common Mistakes

Swapping the order of 'docs' and 'generate'.

Using 'dbt run docs' which is invalid.

The correct command is 'dbt docs generate'. 'dbt generate docs' is incorrect syntax.

4fill in blank

hard

Fill both blanks to generate and serve the dbt documentation site.

dbt

dbt [1] [2]

Drag options to blanks, or click blank then click option'

Adocs

Bserve

Cbuild

Drun

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'dbt build serve' which is invalid.

Using 'dbt run docs' which does not serve docs.

The command 'dbt docs serve' generates and serves the documentation site.

5fill in blank

hard

Fill all three blanks to generate docs, serve them, and open in browser automatically.

dbt

dbt [1] [2] --[3]

Drag options to blanks, or click blank then click option'

Adocs

Bserve

Copen

Dbuild

Attempts:

3 left

💡 Hint

Common Mistakes

Omitting '--open' flag.

Using '--open' without 'serve'.

The command 'dbt docs serve --open' generates docs, serves them, and opens the browser.

Practice

1. What does the command dbt docs generate do in a dbt project?

easy

A. It deletes old documentation files from your project folder.

B. It runs all your data transformations and loads data into the warehouse.

C. It starts a local server to view your documentation site.

D. It creates a website with documentation for your data models and sources.

Solution

1. Step 1: Understand the purpose of dbt docs generate

   This command builds the documentation files for your dbt project, including models and sources.

2. Step 2: Differentiate from other commands

   Unlike dbt run which runs transformations or dbt docs serve which serves the docs, dbt docs generate only creates the documentation files.

3. Final Answer:

   It creates a website with documentation for your data models and sources. -> Option D

4. Quick Check:

   dbt docs generate builds docs [OK]

Hint: Generate docs builds files; serve shows them [OK]

Common Mistakes:

• Confusing generate with run or serve commands
• Thinking it runs data transformations
• Assuming it deletes files

2. Which of the following is the correct command to view the generated documentation site locally?

easy

A. dbt docs view

B. dbt docs generate

C. dbt docs serve

D. dbt docs start

Solution

1. Step 1: Identify the command to serve docs

   The command dbt docs serve starts a local web server to view the generated documentation site.

2. Step 2: Confirm other options are incorrect

   dbt docs generate only creates docs files, while dbt docs view and dbt docs start are not valid dbt commands.

3. Final Answer:

   dbt docs serve -> Option C

4. Quick Check:

   Serve command shows docs locally [OK]

Hint: Serve command launches docs site locally [OK]

Common Mistakes:

• Using generate instead of serve to view docs
• Typing invalid commands like docs view or docs start
• Confusing generate and serve commands

3. Given the following commands run in order:

dbt docs generate
dbt docs serve

What will happen after running these commands?

medium

A. The documentation site is created and then opened in a local web browser.

B. The data models are rebuilt and the docs site is deleted.

C. Only the documentation files are created but not viewable.

D. An error occurs because docs serve must run before docs generate.

Solution

1. Step 1: Understand the effect of dbt docs generate

   This command creates the documentation files needed for the docs site.

2. Step 2: Understand the effect of dbt docs serve

   This command starts a local server and opens the docs site in a browser using the generated files.

3. Final Answer:

   The documentation site is created and then opened in a local web browser. -> Option A

4. Quick Check:

   Generate then serve shows docs [OK]

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

Common Mistakes:

• Thinking docs serve deletes docs
• Believing docs serve must run before generate
• Assuming docs generate runs data models

4. You ran dbt docs serve but the documentation site does not open in your browser. What is the most likely cause?

medium

A. You need to run dbt run before serving docs.

B. You forgot to run dbt docs generate first to create the docs files.

C. The dbt docs serve command requires an internet connection.

D. Your dbt project has no models defined.

Solution

1. Step 1: Check prerequisites for serving docs

   The dbt docs serve command needs the documentation files created by dbt docs generate.

2. Step 2: Identify missing step

   If dbt docs generate was not run, the docs files don't exist, so the site won't open.

3. Final Answer:

   You forgot to run dbt docs generate first to create the docs files. -> Option B

4. Quick Check:

   Generate docs before serving [OK]

Hint: Always generate docs before serving [OK]

Common Mistakes:

• Assuming docs serve works without generated files
• Thinking internet is required for docs serve
• Believing dbt run affects docs serving

5. You want to share your dbt project's documentation site with your team without running dbt docs serve locally. Which approach is best?

hard

A. Generate the docs with dbt docs generate and upload the generated files to a web server.

B. Run dbt docs serve and share your local IP address with the team.

C. Send your team the dbt_project.yml file to generate docs themselves.

D. Use dbt run to automatically publish docs online.

Solution

1. Step 1: Understand how docs are generated and shared

   dbt docs generate creates static documentation files that can be hosted anywhere.

2. Step 2: Identify best way to share without local serving

   Uploading generated docs to a web server allows team members to access the docs anytime without running commands locally.

3. Final Answer:

   Generate the docs with dbt docs generate and upload the generated files to a web server. -> Option A

4. Quick Check:

   Upload generated docs for team access [OK]

Hint: Upload generated docs files to share site [OK]

Common Mistakes:

• Sharing local IP which may not be accessible
• Sending config files instead of docs
• Thinking dbt run publishes docs automatically