mattberns / docs.getdbt.com Goto Github PK

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.com
• next: 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:

1. Ensure node is installed: brew install node
2. Clone this repo: git clone [email protected]:fishtown-analytics/docs.getdbt.com.git
3. cd into the repo: cd docs.getdbt.com
4. And then cd into the website subdirectory: cd website
5. Install the required node packages: npm install
6. Build the website: npm start
7. Before pushing your changes to a branch, check that all links work by using the make build script.

You can also check out this Loom video that I recorded for co-workers — it covers setting up docs.getdbt.com locally, and adding a page with links and images. Heads up — this was very much something I did on the fly, so is not super polished!

Check out docs.getdbt.com/styles for examples of different components that can be used in these docs.

You can also use components directly from the docusaurus library.