Fix Heap embeds for docs sites — staging branch#340
Fix Heap embeds for docs sites — staging branch#340nrichers merged 2 commits intostagingvalidmind/documentation:stagingfrom nrichers/sc-6285/fix-heap-embeds-for-docs-sites-stagingvalidmind/documentation:nrichers/sc-6285/fix-heap-embeds-for-docs-sites-stagingCopy head branch name to clipboard
staging branch#340Conversation
|
|
|
A PR preview is available: Preview URL |
2bce2fb to
d776134
Compare
PR SummaryThis pull request updates the heap analytics script to use the development environment instead of the production environment. The changes include:
Test Suggestions
|
staging branchstaging branch
validbeck
left a comment
There was a problem hiding this comment.
How do we ensure that this isn't overwritten automatically when main is merged into staging?
For the three PRs that I have on the go, you want to merge them in the right sequence: After that, the only way this would get overwritten is if someone deliberately re-adds Heap tracking to |
|
A PR preview is available: Preview URL |
I guess my confusion is won't what's in |
Files differing between branches is not a concern, they should be transparent to GitHub unless there is an actual commit that needs to be merged from one branch into another. |
That's what I mean, when we merge from |
* Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development * Fix heap embeds for docs sites — staging branch (#340) * Doc: Archive and delete inventory models (#351) * Delete model findings draft * Tweaks to project > model * Draft for Archive & delete models * Oops carried changes from a working branch instead of main, reverting * Tweaking wording * Indecisive about wording today * Added archive & delete to sidebar * Final tweaks based on what's on staging * Typo * Tired, tweaks * Update site/guide/model-inventory/archive-delete-models.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped model findings docs for attachments (#352) * Draft * More fiddling * Fiddling * Link tweaks * More project tweaks * Editing based on demo * Created new Working with model findings landing * 1st pass of broken links * 2nd pass of broken links * Summary drafts * Tweaks * More tweaks * Adjustments for prod * Adding deletion after discussion * Images * Removed commented out indications for required fields * New all model findings image * Pulling in latest changes from PR184 (#350) * Pulled in latest test descriptions Sept 03 2024 * Example retrieval for process docs * Delete finding docs update (#355) * Delete finding update, also python docs from main? * Changed to Add and manage model findings * Moved activity to model inventory & adjusted pages (#358) * Moved activity to model inventory & adjusted pages * Missed a link apparently thanks workflow * Missed an external link * Training updates related to creating videos (#227) * Update training title slides * Move training into navbar * Fix glossary entry * Rename training overview file * Fix links to old training filename * Minor styling tweaks before recording videos * Add instruction to verify workflow * Clean up * Update title * Comment out banner * Re-added announcement, but for our technical brief * lil divider for funsies --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Clarified style guidelines for links & training (#363) * Inline link & training draft * Edits to footnotes * Example images * Footnotes * Tweaks * Typos * Update site/about/contributing/style-guide/conventions.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edited the other front matter ref --------- 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> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
* Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development * Fix heap embeds for docs sites — staging branch (#340) * Doc: Archive and delete inventory models (#351) * Delete model findings draft * Tweaks to project > model * Draft for Archive & delete models * Oops carried changes from a working branch instead of main, reverting * Tweaking wording * Indecisive about wording today * Added archive & delete to sidebar * Final tweaks based on what's on staging * Typo * Tired, tweaks * Update site/guide/model-inventory/archive-delete-models.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped model findings docs for attachments (#352) * Draft * More fiddling * Fiddling * Link tweaks * More project tweaks * Editing based on demo * Created new Working with model findings landing * 1st pass of broken links * 2nd pass of broken links * Summary drafts * Tweaks * More tweaks * Adjustments for prod * Adding deletion after discussion * Images * Removed commented out indications for required fields * New all model findings image * Pulling in latest changes from PR184 (#350) * Pulled in latest test descriptions Sept 03 2024 * Example retrieval for process docs * Delete finding docs update (#355) * Delete finding update, also python docs from main? * Changed to Add and manage model findings * Moved activity to model inventory & adjusted pages (#358) * Moved activity to model inventory & adjusted pages * Missed a link apparently thanks workflow * Missed an external link * Training updates related to creating videos (#227) * Update training title slides * Move training into navbar * Fix glossary entry * Rename training overview file * Fix links to old training filename * Minor styling tweaks before recording videos * Add instruction to verify workflow * Clean up * Update title * Comment out banner * Re-added announcement, but for our technical brief * lil divider for funsies --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Clarified style guidelines for links & training (#363) * Inline link & training draft * Edits to footnotes * Example images * Footnotes * Tweaks * Typos * Update site/about/contributing/style-guide/conventions.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edited the other front matter ref --------- Co-authored-by: Nik Richers <nik@validmind.ai> --------- 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>
* [create-pull-request] automated change * Update rendered site * Delete site/_site directory in staging (#326) * Delete site/_site directory in prod (#328) * Merging staging into prod (#331) * Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) --------- 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> * Merge staging into prod (#338) * Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source --------- 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> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Delete .github/workflows/render-site.yaml (#344) * Pushing changes from `staging` into `prod` (#347) * Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development --------- 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> * Fix heap embeds for docs sites — staging branch (#340) * Merge staging into prod fix conflicts (#365) * Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development * Fix heap embeds for docs sites — staging branch (#340) * Doc: Archive and delete inventory models (#351) * Delete model findings draft * Tweaks to project > model * Draft for Archive & delete models * Oops carried changes from a working branch instead of main, reverting * Tweaking wording * Indecisive about wording today * Added archive & delete to sidebar * Final tweaks based on what's on staging * Typo * Tired, tweaks * Update site/guide/model-inventory/archive-delete-models.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped model findings docs for attachments (#352) * Draft * More fiddling * Fiddling * Link tweaks * More project tweaks * Editing based on demo * Created new Working with model findings landing * 1st pass of broken links * 2nd pass of broken links * Summary drafts * Tweaks * More tweaks * Adjustments for prod * Adding deletion after discussion * Images * Removed commented out indications for required fields * New all model findings image * Pulling in latest changes from PR184 (#350) * Pulled in latest test descriptions Sept 03 2024 * Example retrieval for process docs * Delete finding docs update (#355) * Delete finding update, also python docs from main? * Changed to Add and manage model findings * Moved activity to model inventory & adjusted pages (#358) * Moved activity to model inventory & adjusted pages * Missed a link apparently thanks workflow * Missed an external link * Training updates related to creating videos (#227) * Update training title slides * Move training into navbar * Fix glossary entry * Rename training overview file * Fix links to old training filename * Minor styling tweaks before recording videos * Add instruction to verify workflow * Clean up * Update title * Comment out banner * Re-added announcement, but for our technical brief * lil divider for funsies --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Clarified style guidelines for links & training (#363) * Inline link & training draft * Edits to footnotes * Example images * Footnotes * Tweaks * Typos * Update site/about/contributing/style-guide/conventions.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edited the other front matter ref --------- 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> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Publishing changes from PR #340 onwards (#362) * Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development * Fix heap embeds for docs sites — staging branch (#340) * Doc: Archive and delete inventory models (#351) * Delete model findings draft * Tweaks to project > model * Draft for Archive & delete models * Oops carried changes from a working branch instead of main, reverting * Tweaking wording * Indecisive about wording today * Added archive & delete to sidebar * Final tweaks based on what's on staging * Typo * Tired, tweaks * Update site/guide/model-inventory/archive-delete-models.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped model findings docs for attachments (#352) * Draft * More fiddling * Fiddling * Link tweaks * More project tweaks * Editing based on demo * Created new Working with model findings landing * 1st pass of broken links * 2nd pass of broken links * Summary drafts * Tweaks * More tweaks * Adjustments for prod * Adding deletion after discussion * Images * Removed commented out indications for required fields * New all model findings image * Pulling in latest changes from PR184 (#350) * Pulled in latest test descriptions Sept 03 2024 * Example retrieval for process docs * Delete finding docs update (#355) * Delete finding update, also python docs from main? * Changed to Add and manage model findings * Moved activity to model inventory & adjusted pages (#358) * Moved activity to model inventory & adjusted pages * Missed a link apparently thanks workflow * Missed an external link * Training updates related to creating videos (#227) * Update training title slides * Move training into navbar * Fix glossary entry * Rename training overview file * Fix links to old training filename * Minor styling tweaks before recording videos * Add instruction to verify workflow * Clean up * Update title * Comment out banner * Re-added announcement, but for our technical brief * lil divider for funsies --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Clarified style guidelines for links & training (#363) * Inline link & training draft * Edits to footnotes * Example images * Footnotes * Tweaks * Typos * Update site/about/contributing/style-guide/conventions.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edited the other front matter ref --------- Co-authored-by: Nik Richers <nik@validmind.ai> --------- 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> --------- 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> Co-authored-by: nrichers <nrichers@users.noreply.github.com> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
* Add staging docs site deploy and update prod deploy (#309) * Add new staging docs site deploy action and workflow * Change to PR branch for testing * Change to PR branch for testing, take 2 * Add quarto render steps to staging and prod workflows * Minor wording fix * Minor wording tweaks * Change to prod site for testing * Fix path issue in aws command, revert to correct branches * Remove some GitHub variables * Switch staging deploy to new AWS access keys * Switch to PR branch for testing * Fix duplicate names * Update bucket region info * Formatting * Update Cloudfront info for staging and debug paths * More path debugging * More path debugging * Fix deploy paths & remove debugging info * Switch back to staging branch * Change to PR branch for testing * Change back to staging branch * Change to PR branch and docs-demo bucket for testing * Change back to prod branch and prod bucket * Delete site/_site directory in staging (#326) * Revamped Model Activity docs (#315) * Filter activity setup * Simplified some inline links * Draft of edited unless-format footnotes * Edited unless-format for Model Activity & Document Overview * Edited unless-format for Submit for approval * Edited unless-format for Assess compliance * Edited unless-format for Work with model findings * Fixed broken links in single-source * Edits based on what is available locally * Final tweaks * Added single-source template * Update README.md * Update README.md * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Release notes for Sept 9 2024 (#329) * Draft of new release notes * Edited validation guidelines release * Draft -need to edit bug fixes * Why did it not commit all files?? * Final tweaks to body * Summary added * Grammar?? * Removed extra documentation as requested * Removed bug fixes * My brain is not on today, typo * Only running the PR previews bot when a PR is ready for review (#330) * Can we make it only run once let's see * Updated to review_requested * Modify make python-docs to support rendering online (#336) * Modify make python-docs to store files in site folder * Add python-docs to source * Delete .github/workflows/render-site.yaml (#344) * Investigate listing page issue (#334) * Remove echoing to log file * Add quarto check to workflow * Add TinyTex install * Experiment by removing tabset * Remove TinyTex install * Re-add tabset, try individual file embeds * Try changing wildcard embed * Try different wildcard embed * Undo workflow changes * Fix Heap embeds for docs sites — `main` branch (#339) * Remove production Heap embed * Re-add Heap file for development * Fix heap embeds for docs sites — staging branch (#340) * Doc: Archive and delete inventory models (#351) * Delete model findings draft * Tweaks to project > model * Draft for Archive & delete models * Oops carried changes from a working branch instead of main, reverting * Tweaking wording * Indecisive about wording today * Added archive & delete to sidebar * Final tweaks based on what's on staging * Typo * Tired, tweaks * Update site/guide/model-inventory/archive-delete-models.qmd Co-authored-by: Nik Richers <nik@validmind.ai> --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped model findings docs for attachments (#352) * Draft * More fiddling * Fiddling * Link tweaks * More project tweaks * Editing based on demo * Created new Working with model findings landing * 1st pass of broken links * 2nd pass of broken links * Summary drafts * Tweaks * More tweaks * Adjustments for prod * Adding deletion after discussion * Images * Removed commented out indications for required fields * New all model findings image * Pulling in latest changes from PR184 (#350) * Pulled in latest test descriptions Sept 03 2024 * Example retrieval for process docs * Delete finding docs update (#355) * Delete finding update, also python docs from main? * Changed to Add and manage model findings * Moved activity to model inventory & adjusted pages (#358) * Moved activity to model inventory & adjusted pages * Missed a link apparently thanks workflow * Missed an external link * Training updates related to creating videos (#227) * Update training title slides * Move training into navbar * Fix glossary entry * Rename training overview file * Fix links to old training filename * Minor styling tweaks before recording videos * Add instruction to verify workflow * Clean up * Update title * Comment out banner * Re-added announcement, but for our technical brief * lil divider for funsies --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Clarified style guidelines for links & training (#363) * Inline link & training draft * Edits to footnotes * Example images * Footnotes * Tweaks * Typos * Update site/about/contributing/style-guide/conventions.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Edited the other front matter ref --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Adding new ValidMind colors & logo (#366) * Start adding updated ValidMind colors & logo * Bit more of that lovely green * Prereq tweak --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update workflows to trigger on workflow_run (#368) * Update workflows to enable workflow_run * Experiment with workflow_dispatch * Update README.md (#369) * Use Quarto profiles for rendering the site on GitHub and locally (#372) * Move Heap info its own environment folder * Add Quarto profiles * Add profiles for more development builds * Docs site audit accuracy tone review — Guides p1 (#377) * Edits to swap docs templates * Added ongoing monitoring to swap templates * Cleaned up guides.qmd * Cleaned up log-in-to-validmind.qmd * Cleaned up set-up-your-organization.qmd * Cleaned up configure-google... .qmd * Cleaned up managing-users .qmd * Cleaned up manage-users.qmd * Cleaned up manage-groups.qmd * Cleaned up manage-roles.qmd * Cleaned up manage-your-profile.qmd * Cleaned up customize-your-dashboard.qmd * Cleaned up working-with-model-workflows.qmd * Cleaned up customize-model-lifecycle-statuses.qmd * Cleaned up set-up-model-workflows.qmd * Cleaned up working-with-model-inventory.qmd * Cleaned up register-models-in-inventory.qmd * Cleaned up customize-model-inventory-layout.qmd * Cleaned up edit-model-inventory-fields.qmd * Cleaned up view-model-activity.qmd * Cleaned up configure-model-interdependencies.qmd * Cleaned up manage-model-inventory-fields.qmd * Tweaks for model stage columns * Cleaned up view-documentation-templates.qmd * Cleaned up customize-documentation-templates.qmd * Cleaned up swap-documentation-templates.qmd * Cleaned up assign-documentation-section-statuses.qmd * Cleaned up submit-for-approval.qmd * Cleaned up export-documentation.qmd * Cleaned up collaborate-with-others.qmd * Project > Model updates * Cleaned up manage-validation-guidelines.qmd * Cleaned up pereparing-validation-reports.qmd * Cleaned up review-model-documentation.qmd * Cleaned up assess-compliance.qmd * Cleaned enable-monitoring.qmd * Cleaned review-monitoring-results.qmd * Final tweaks * Captions added to configuration/ * Captions added to model-workflows/ * Captions added to model-inventory/ * Captions added to model-documentation/ * Captions added to model-validation/ * Captions added to monitoring/ * Update site/guide/configuration/configure-aws-privatelink.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Quick tweak --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Revamped View reports (#409) * Draft edits * New images * Setup for overview of data * Final revamp, +customizing model findings view * Final tweaks * Update site/guide/model-validation/view-filter-model-findings.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Adjusted casing for report widgets --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Updated Work with content blocks (#390) * Draft of metric over time blocks info * Draft for toolbar overview * Adjusting images * Edits for toolbar * Quick tweak * Quick single source * Make training slides more photogenic (#412) * Add docs.validmind.ai/training redirect * Update backgrounds, remove slide numbering, add slide links * Documented user registration process (#410) * Draft new pages * New files * Draft for independent signup * Last save for the day * Simplifying some stuff * Accept invitation draft * Layout tweaks * Accept invite wip * Register done for now * New registration variable * Applied new variable across site * Final tweaks * Quick tweak * Cropped images * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Tweaks --------- 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> Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Internal Notes for Reviewers
This PR follows #339 and enables tracking for Heap in
stagingusing the correct development project in Heap.External Release Notes