Is there is a way to export dbt docs from the cloud website and share it across the teams?
1 Like
You can’t “export” the files from dbt Cloud, but it’s easy to rebuild them with dbt docs generate.
The docs site is a static SPA, so it’s pretty easy to host anywhere – you just copy the artifacts from dbt docs generate into S3 or another hosting provider. Official docs are here.
I’ve used GitHub pages for this, since all you have to do is copy the artifacts into a subdirectory in your project, and GitHub will automatically host them. See this package for an example. I have make command to generate the docs and move them from the /integration-tests/target directory to the /docs directory. Then you can configure GitHub Pages in your repo settings to serve the /docs directory. Here’s the config:
If you need auth, you can use Netlify: Publishing dbt Docs to Netlify - Show and Tell - dbt Community Forum (getdbt.com)
You can also create read-only viewer accounts for your colleagues to access
But there’s a limited number of read-only users, right ? So if you run out of them eventually?
Note: @Richard Rivera originally posted this reply in Slack. It might not have transferred perfectly.
It’s possible to buy more if you need extras
What about Confluence? Is there any way to publish documentation in Confluence? I see they allow static
https://confluence.atlassian.com/confkb/how-to-use-confluence-to-serve-static-content-677282407.html
But is this possible for dbt core docs?
As a non-profit, it would be difficult for me to propose buying extra licenses for documentation purposes only. Our end users wouldn’t be comfortable using GitHub either. They need a portal with something they’re more used to - Sharepoint, Smartsheet, Confluence, etc. Are there any other options out there? I looked at Netlify but it isn’t free, so I’m in the same situation as I would be in buying more dbt licenses.