Feat/auto generate enhanced catalog #103
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Modified deploy_user_index_html() to fallback to opendbt's enhanced UI - If no user-provided index.html found in docs_paths, automatically copies opendbt/dbt/docs/index.html to target directory - Applies to both dbt v17 and v18 task implementations - Users can still override by providing their own index.html in docs_paths This change makes the enhanced catalog UI (with column-level lineage, dependency graphs, and modern Vue.js interface) available out-of-the-box without requiring users to manually copy files. Note: catalogl.json generation already happens automatically via generate_opendbt_catalogl_json() method.
- Modified deploy_user_index_html() to fallback to opendbt's enhanced UI - If no user-provided index.html found in docs_paths, automatically copies opendbt/dbt/docs/index.html to target directory - Applies to both dbt v17 and v18 task implementations - Users can still override by providing their own index.html in docs_paths - Added comprehensive documentation on generating and customizing catalog UI - Bumped version to 0.14.2 This change makes the enhanced catalog UI (with column-level lineage, dependency graphs, and modern Vue.js interface) available out-of-the-box without requiring users to manually copy files. Usage: python -m opendbt docs generate Note: catalogl.json generation already happens automatically via generate_opendbt_catalogl_json() method.
|
Great improvements for docs. Thank you @LexxaRRioo merged |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue:
I've got a default dbt docs UI and had no idea how to switch to opendbt version of Data Catalog (like in Demo).
Suggestion:
Add clear docs explanation how to generate yours index.html and automate it a bit.
Context:
It was a bit frustrating to get default UI instead of your version with column-level lineage data catalog.
I've figured out that index.html has to be somewhere in the repo, but I suggest to automate and document this process for other users.
p.s. how to bump patch version in release? I've bumped pyproject.toml version