openedx / aspects-dbt

The dbt project for Open edX Aspects!
Apache License 2.0
2 stars 4 forks source link

feat: add dbt documentation #31

Closed Ian2012 closed 11 months ago

Ian2012 commented 11 months ago

Description

This PR creates a GitHub workflow to generate the DBT docs and publish it to GitHub pages.

The destination branch is gh-pages and the documentation is generated on every push a main.

openedx-webhooks commented 11 months ago

Thanks for the pull request, @Ian2012! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

Ian2012 commented 11 months ago

cc @SoryRawyer

bmtcril commented 11 months ago

This won't work because the static content needs to be served out of either the site root or the /docs/ directory. I think we can use this as a template: https://medium.com/dbt-local-taiwan/host-dbt-documentation-site-with-github-pages-in-5-minutes-7b80e8b62feb

If you set up a gh-pages branch with the contents of the target dir like in that post I can create the static site and we can work on setting up an action to automatically push to that branch when something merges to main.

Ian2012 commented 11 months ago

Seems like the SEMANTIC_RELEASE_BOT doesn't have access to this repository

openedx-webhooks commented 11 months ago

@Ian2012 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.