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

[CT-3105] [Feature] Generate static documentation (static_index.html) #8614

Closed
3 tasks done
mescanne opened this issue Sep 11, 2023 · 0 comments · Fixed by #8615
Closed
3 tasks done

[CT-3105] [Feature] Generate static documentation (static_index.html) #8614

mescanne opened this issue Sep 11, 2023 · 0 comments · Fixed by #8615
Assignees
Labels
enhancement New feature or request

Comments

@mescanne
Copy link
Contributor

Is this your first time submitting a feature request?

  • I have read the expectations for open source contributors
  • I have searched the existing issues, and I could not find an existing issue for this feature
  • I am requesting a straightforward extension of existing dbt functionality, rather than a Big Idea better suited to a discussion

Describe the feature

Static webpages (all resources bundled within them) are very useful -- you can inspect them directly without starting a webbrowser, and they can be served by e.g. object stores.

There is a long-standing feature request in dbt-docs for this here. I have created a PR within dbt-docs and will be creating a PR within dbt-core based on its output.

Describe alternatives you've considered

External tools (as described in the dbt-docs issue) can be created, but this is ugly and a hack.

In terms of doing this properly (within dbt itself), I considered a few other alternatives -- delayed webpack, bundling within Python (dbt-core), but all of these are both very complicated, different to how things are working now.

Who will this benefit?

See the history of dbt-docs issue for some of the benefits.

One specific example is hosting in Google Cloud Storage buckets -- a static index.html can be directly shared using GCP permissions, while one that retrieves manifest.json and catalog.json cannot. The bucket must either be public (usually undesirable) or exposed through a webserver (more complex).

Are you interested in contributing this feature?

Yes. PR will be attached.

Anything else?

No response

@mescanne mescanne added enhancement New feature or request triage labels Sep 11, 2023
@github-actions github-actions bot changed the title [Feature] Generate static documentation (static_index.html) [CT-3105] [Feature] Generate static documentation (static_index.html) Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants