Feature: Add documentation website #91
Conversation
luiherch
changed the title
|
Thanks for submitting this, @luiherch! I'll review this PR this week. |
There was a problem hiding this comment.
@luiherch thanks for making this pull request! There are two areas for improvement before this can be merged:
- Removing the trademarked dbt logo
- Adding all missing docs site dependencies to
pyproject.toml
Please let me know if you have any questions!
| !!! warning | ||
| dbt core's plugin functionality is still in beta. Please note that this may break in the future as dbt Labs solidifies the dbt plugin API in future versions. |
There was a problem hiding this comment.
Suggestion: I think the plugin interface has been around long enough that we're good to remove this warning.
| run: | | ||
| git config --global user.name "GitHub Actions Bot" | ||
| git config --global user.email "github-actions[bot]@users.noreply.github.com" | ||
| poetry run mike deploy --push --force --message "Deployed by GitHub Actions" main |
There was a problem hiding this comment.
Issue: It looks like we're missing the mkdocs-material dependency for the documentation site, and the mike dependency for managing the deployment.
Suggestion: I'd recommend adding a new dependency group called docs that has all of the deps required to build the docs site, and then update the Install dependencies step on line 26 to install the new docs group instead of the dev group.
| @@ -44,7 +44,7 @@ dbt-loom currently supports obtaining model definitions from: | |||
|
|
|||
| ## Getting Started | |||
|
|
|||
| To being, install the `dbt-loom` python package. | |||
| To begin, install the `dbt-loom` python package. | |||
There was a problem hiding this comment.
Praise: Great catch! Thanks for fixing this.
There was a problem hiding this comment.
Issue: Alas, this logo is definitely a trademark of dbt Labs, so it'll have to go. We should be fine using only the dbt-loom name for now, although I'm open to other logo ideas if you have one stashed away.
|
Thanks for the hard work! I'm going to merge this into an in-repo branch so I can make the necessary improvements. This will be merged soon. |
Add material mkdocs documentation website