alf-mindshift / dbt-docs

Auto-generated data documentation site for dbt projects

dbt docs

dbt (data build tool) helps analysts write reliable, modular code using a workflow that closely mirrors software development.

This repository contains code for generating a documentation site for dbt projects. Check out the dbt documentation for more information.

---

Getting Started

• What is dbt?
• Read the dbt viewpoint
• Installation
• Join the chat on Slack for live questions and support.

Code of Conduct

Everyone interacting in the dbt project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

Development

After cloning this repository, run:

git submodule update --init --recursive

Then, install yarn and webpack.

npm install -g yarn webpack webpack-cli

You'll also need to install jekyll if you don't already have it:

gem install bundler jekyll

Build / Run

To build the css files required for webpack:

cd styles
jekyll build
cd -

To build an index.html file:

yarn install
webpack

To run the dev server, first copy your manifest.json, catalog.json, and run_results.json files to the src/ directory. Then run:

yarn install
npm start