-
Notifications
You must be signed in to change notification settings - Fork 4
Add make execute PROFILE=exe-prod to docs-site action #598
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
Add make execute PROFILE=exe-prod to docs-site action #598
Conversation
PR SummaryThis pull request introduces an enhancement to the Test Suggestions
|
PR SummaryThis pull request introduces an enhancement to the Docker build process in the Test Suggestions
|
A PR preview is available: Preview URL |
@nibalizer @validbeck can we make a decision on this PR? My inclination is to merge this and then figure out how to help Spencer with rendering the docs site. (I also made an additional change in 1d05411 to move the execution of the notebook into our |
Yep lets get this in! Thank you! |
* Add make execute PROFILE=exe-prod to docs-site action (#598) * Add execute PROFILE=exe-prod to Docker image build * Move notebook execution into docs-site action * Docs — Customize model overview page (#622) * Draft customize-model-overview-page.qmd * Quick instructions * Edits based on feedback from Rod * Updated docs — Workflows (#620) * Tweak to release generation notebook * Wait, gotta make the file first * Wording in notebook * Just being picky about spaces now * Adding open file to yearly_cleanup.py too * Success * Edits to customize-model-lifecycle-statuses.qmd * New img - working-with-model-workflows.qmd > See workflow statuses * +reset-workflow.gif to working-with-model-workflows.qmd * Updated set-up-model-workflows.qmd > Configure workflow steps * Updated configure-user-action.png * Updated approval-group-setup.png * Redid the Approval Step example/images * Redid the Condition Branch example/images * Changed linked-workflow image to a gif * Updated set-up-model-workflows.qmd > Link approval steps * Changed my mind about the model-workflows.png screencap * Tweak * Simplifying based on Rod's suggestion * QoL improvements to release notes script/notebooks (#626) * Testing adding the year to generated release notes * oops, forgot to parse the date format * Now the folder is swapped ugh * Adding the year to the _quarto.yml entry * Oops, forgot to add the input * Casing * Adding new year folder to index function * Grabbing yearly folders in established year * Fake 2025 releases for testing & modifying Makefile command * Fake 2026 release for yearly cleanup test * Trying the yearly lookup again * Yearly lookup works * Retrieve year folder * Commenting out move releases for now * Removed move releases * Modifying update_quarto_yaml * Cleaning up the Makefile command * Notebook wording cleanup * Removing test files & reverting _quarto.yml & index.qmd to main * Added aliases for moved 2024 releases * Added aliases for moved 2023 releases * Whoops, wrong alias for some of the super old releases * Nitpicky edit * Meh * Nitpicking the output * Added instructions for Wait steps in workflows (#628) * Edits to date & date-time custom fields * Wait step draft * Edits & footnotes --------- Co-authored-by: Nik Richers <nik@validmind.ai> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Internal Notes for Reviewers
This PR executes the notebook we use for our developer fundamentals training course as part of
building the Docker image of ourrendering our docs site.EDIT: I moved the execute action into the docs-site action rather than calling it when building the Docker image. This means that rendering the docs site locally always executes the notebook rather than only when building the Docker image. I think that approach makes more sense logically since rendering the docs site should, well, render the (complete) docs site.
Fixes: sc-7834
Proof it works
JavaScript widgets show up, e.g.:
Notable stuff:
Uses the correct profile for production —
quarto render --profile exe-prod notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb
There's some ominous stuff in the console output, plus some warnings:
External Release Notes