Skip to content

Investigate listing page issue #334

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

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Sep 6, 2024

Internal Notes for Reviewers

This PR modifies our test description wildcard embeds from ** to *.md to resolve duplicated but blank tiles.

Before — docs.validmind.ai After — Preview URL
image image

Note this change seems to work just fine for subdirectories.

Troubleshooting approach

  • Turn off echoing the quarto render output into a logfile so that we can see the output
  • Debugging
    • Test rendering on a local Linux container — output looks fine
    • Run quarto check before render — looks OK
  • Add any missing extensions
    • TinyTex — no difference
  • Experiment with the source
    • Try removing tabset as the problem occurs only in tabs — no difference
    • Try a directory embed without wildcard — does not work despite what the Quarto docs say
    • Try a *.md wildcard embed — works, including for subdirectories

During testing on a local Linux container, the site rendered just fine but if we continue to run into issues that point towards differences with Linux runners on GitHub, we could also try testing on macos-latest. For more info, see Standard GitHub-hosted runners for public repositories.

External Release Notes

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Sep 6, 2024
Copy link
Contributor

github-actions bot commented Sep 6, 2024

PR Summary

This pull request simplifies the Quarto render command in the GitHub Actions workflow file (.github/workflows/validate-docs-site.yaml). The previous implementation redirected the output to a log file and checked for errors immediately, whereas the new implementation directly runs the quarto render command without additional error handling or logging.

Changes:

  • Removed the redirection of quarto render output to render_errors.log.
  • Removed the immediate error check and log file output in case of failure.

Test Suggestions

  • Verify that the GitHub Actions workflow runs successfully without the additional error handling.
  • Check if the quarto render command completes without errors in different scenarios (e.g., with and without actual rendering issues).
  • Ensure that the absence of the log file does not affect the overall workflow or debugging process.

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

Copy link
Contributor

github-actions bot commented Sep 6, 2024

A PR preview is available: Preview URL

@nrichers nrichers requested a review from validbeck September 7, 2024 00:30
Copy link
Contributor

github-actions bot commented Sep 7, 2024

PR Summary

This pull request updates the paths for test descriptions in the site/developer/model-testing/test-descriptions.qmd file. The changes ensure that only Markdown files (*.md) are included in the test descriptions for data validation, model validation, prompt validation, and ongoing monitoring. Previously, the paths were set to include all files (**), which could lead to the inclusion of non-Markdown files.

The specific changes are:

  • Updated contents paths from ../../tests/data_validation/** to ../../tests/data_validation/*.md
  • Updated contents paths from ../../tests/model_validation/** to ../../tests/model_validation/*.md
  • Updated contents paths from ../../tests/prompt_validation/** to ../../tests/prompt_validation/*.md
  • Updated contents paths from ../../tests/ongoing_monitoring/** to ../../tests/ongoing_monitoring/*.md

Test Suggestions

  • Verify that only Markdown files are included in the test descriptions for data validation, model validation, prompt validation, and ongoing monitoring.
  • Check that the test descriptions render correctly on the site after the changes.
  • Ensure that no non-Markdown files are mistakenly included in the test descriptions.

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Can I be the one to publish this change to prod (so I can test the process?).

@nrichers
Copy link
Collaborator Author

nrichers commented Sep 9, 2024

Looks great! Can I be the one to publish this change to prod (so I can test the process?).

Yes, but give me an hour or so? I didn't get to give my demo this morning and am recording a quick video that uses this and other PRs that I have on the go to demo the process.

@nrichers nrichers merged commit cd115ca into main Sep 9, 2024
9 checks passed
@nrichers nrichers deleted the nrichers/sc-6331/investigate-listing-page-issue-for-test-descriptions branch September 9, 2024 18:55
@nrichers
Copy link
Collaborator Author

nrichers commented Sep 9, 2024

@validbeck I'm done recording my demo — please go ahead and deploy to prod.

validbeck added a commit that referenced this pull request Sep 9, 2024
* 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>
nrichers added a commit that referenced this pull request Sep 13, 2024
* 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>
validbeck added a commit that referenced this pull request Sep 13, 2024
* 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>
nrichers added a commit that referenced this pull request Sep 20, 2024
* [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>
nrichers added a commit that referenced this pull request Sep 21, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Docs infra changes internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants