Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Data catalog] Deploy the dbt-generated documentation as a static site #33

Closed
jeancochrane opened this issue Jul 26, 2023 · 1 comment
Closed
Assignees

Comments

@jeancochrane
Copy link
Contributor

Running dbt docs generate in the dbt/ directory will generate target/index.html, an HTML version of the documentation for our dbt models and tests. Use this file to deploy our documentation as a static site.

There are a number of good options for deploying static sites; in roughly descending order of preference:

  1. GitHub Pages
  2. AWS S3 with a CloudFront CDN
  3. Netlify

GitHub Pages is preferred since it is easy to use and already integrated into GitHub; S3 + CloudFront is next on the list since we already pay for AWS; and Netlify is last in the priority queue because we don't use it yet, but it's very easy to set up so it's a plausible option if the first two don't work for whatever reason.

@jeancochrane
Copy link
Contributor Author

We're going to use GitHub Pages to deploy the site via an Action, so I'm going to archive this issue in favor of #34.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant