A docusaurus site that powers docs.getdbt.com.
There are two long-lived branches in this repo:
current
: This branch is what is reflected at at docs.getdbt.comnext
: This branch represent the next release of dbt, and is deployed next.docs.getdbt.com
We welcome contributions from community members to this repo:
- Fixes: If you notice an error (there are likely many), use the
Edit this page
button at the bottom of each page to suggest a change. We recommend you contribute small changes directly from the GitHub interface. - New documentation: If you contributed code in dbt-core, we encourage you to also write the docs here!
- Refactors: At this time, we are unable to support community members who wish to re-write sections of docs.getdbt.com. We hope to change this in the future!
If you are contributing significant changes, it may be worth setting up the repo to run locally, as follows:
- Ensure node is installed:
brew install node
- Clone this repo:
[email protected]:fishtown-analytics/dbt.git
cd
into thewebsite
subdirectory- Install the required node packages:
npm install
- Build the website:
npm start
- Before pushing your changes to a branch, check that all links work by using the
make build
script
Check out docs.getdbt.com/styles for examples of different components that can be used in these docs.