Add staging docs site deploy and update prod deploy #309

nrichers · 2024-09-03T00:35:15Z

Internal Notes for Reviewers

This PR includes:

deploy-docs-staging.yaml — a new GitHub workflow to render & deploy our staging docs site whenever a commit to the staging branch is made
make deploy-staging — a new Makefile action to do the same locally
deploy-docs-prod.yaml — an updated GitHub workflow for prod to render the site before deploying

In our new docs CI/CD deployment infra, this PR implements the following highlight:

Proof it works

`deploy-docs-staging.yaml`

Successful run: https://github.com/validmind/documentation/actions/runs/10704868760

Note: The staging S3 bucket is not yet available via DNS, so the way to verify this workflow works is to look at the output of the workflow run.

Here's a screenshot that shows the rendering of the docs site passed and the beginning of the deploy via aws s3 sync:

And here's a sceenshot that shows the end and the clearing of the cache with cloudfront create-invalidation:

`make deploy-staging`

make deploy-staging abridged output when run locally:

❯ make deploy-staging

Deploying staging site ...
[  1/313] guide/configuration/set-up-your-organization.qmd
[  2/313] guide/configuration/configure-google-private-service-connect.qmd
[  3/313] guide/configuration/manage-roles.qmd
...
[311/313] get-started/platform/explore-sample-model-documentation.qmd
[312/313] get-started/platform/next-steps.qmd
[313/313] get-started/quickstart.qmd

make

Updating Python documentation ...

Output created: _site/index.html

upload: _site/404.html to s3://docs-ci-cd-staging/site/404.html                        
upload: _site/about/contributing/join-community.html to s3://docs-ci-cd-staging/site/about/contributing/join-community.html
upload: _site/about/contributing/validmind-community.html to s3://docs-ci-cd-staging/site/about/contributing/validmind-community.html
...
upload: _site/validmind/validmind/vm_models.html to s3://docs-ci-cd-staging/site/validmind/validmind/vm_models.html
upload: _site/validmind/validmind/unit_metrics.html to s3://docs-ci-cd-staging/site/validmind/validmind/unit_metrics.html
upload: _site/validmind/validmind/tests/prompt_validation/Robustness.html to s3://docs-ci-cd-staging/site/validmind/validmind/tests/prompt_validation/Robustness.html

`deploy-docs-prod.yaml`

Successful run: https://github.com/validmind/documentation/actions/runs/10705064385

Note: Using the prod branch and docs-ci-cd-prod S3 bucket for testing is verboten, so I temporarily modified this workflow to deploy the PR branch to the docs-ci-cd-demo bucket. The run proves that the workflow works as expected and it should work for prod as well after this PR gets merged.

There's also the Published date for the docs-demo site that changed as part of this test run (AND we wiped out all the PR previews):

Before deploy	After deploy

How to test

deploy-docs-staging.yaml — Modify this PR to match c979921, commit and push. Undo your changes afterwards.
make deploy-staging — Run this command locally
deploy-docs-prod.yaml — Modify this PR to match 75adf31, commit and push. Undo your changes afterwards.

External Release Notes

sc-6277/deploy-staging-docs-site-workflow

github-actions · 2024-09-03T20:37:50Z

PR Summary

This pull request introduces several enhancements to the documentation deployment workflows. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
Production Documentation Deployment (.github/workflows/deploy-docs-prod.yaml):
- Added steps to download and install the latest Quarto release.
- Introduced a step to render the documentation site using Quarto.
- Updated the deployment step to ensure the rendered site is deployed to the production S3 bucket.
Staging Documentation Deployment (.github/workflows/deploy-docs-staging.yaml):
- Created a new workflow to deploy the documentation site to a staging S3 bucket.
- This workflow includes steps to download and install the latest Quarto release, render the documentation site, and deploy it to the staging S3 bucket.
- Configured AWS credentials and added a step to sync the site to S3 and invalidate the CloudFront cache.
Makefile Enhancements (site/Makefile):
- Added a new deploy-staging target to deploy the documentation site to the staging S3 bucket.
- Updated the help section to include the new deploy-staging target.

These changes aim to streamline the process of deploying documentation to both production and staging environments, ensuring consistency and reliability.

Test Suggestions

Verify that the production documentation deployment workflow completes successfully and the site is updated in the production S3 bucket.
Test the new staging documentation deployment workflow to ensure it correctly deploys the site to the staging S3 bucket.
Check that the Quarto installation step works as expected in both production and staging workflows.
Ensure that the deploy-staging Makefile target functions correctly and deploys the site to the staging S3 bucket.
Validate that the CloudFront cache invalidation step works correctly in both production and staging workflows.

github-actions · 2024-09-03T20:51:19Z

PR Summary

This pull request introduces several enhancements and bug fixes to the documentation deployment workflows. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
Production Documentation Deployment (deploy-docs-prod.yaml):
- Updated the branch trigger to nrichers/sc-6277/deploy-staging-docs-site-workflow.
- Added steps to download and install the latest Quarto release.
- Added a step to render the documentation site using Quarto.
- Added a step to deploy the rendered site to the production S3 bucket.
Staging Documentation Deployment (deploy-docs-staging.yaml):
- Introduced a new workflow to deploy the documentation site to a staging S3 bucket.
- This workflow includes steps to check out the repository, download and install Quarto, render the documentation site, and deploy it to the staging S3 bucket.
- Configured AWS credentials and added a step to sync the site to S3 and invalidate the CloudFront cache.
Makefile Enhancements (site/Makefile):
- Added a new deploy-staging target to deploy the documentation site to the staging S3 bucket.
- Updated the help section to include the new deploy-staging target.

These changes aim to streamline the deployment process for both production and staging environments, ensuring that the latest documentation is always available and up-to-date.

Test Suggestions

Verify that the production documentation deployment workflow (deploy-docs-prod.yaml) successfully deploys the site to the production S3 bucket.
Test the new staging documentation deployment workflow (deploy-docs-staging.yaml) to ensure it correctly deploys the site to the staging S3 bucket.
Check that the Quarto installation and rendering steps work as expected in both production and staging workflows.
Ensure that the AWS credentials configuration and S3 sync steps function correctly in the staging deployment workflow.
Run the deploy-staging target in the Makefile to confirm it deploys the site to the staging S3 bucket as intended.

github-actions · 2024-09-03T21:39:32Z

PR Summary

This pull request introduces several enhancements to the CI/CD workflows and adds a new workflow for deploying the documentation site to a staging environment. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflows.
Production Deployment Workflow (deploy-docs-prod.yaml):
- Updated the workflow name to 'Deploy docs site to production'.
- Added steps to download and install the latest Quarto release.
- Added a step to render the documentation site using Quarto.
- Updated the S3 sync command to use the correct directory.
Staging Deployment Workflow (deploy-docs-staging.yaml):
- Introduced a new workflow to deploy the documentation site to a staging environment whenever a commit is pushed to the staging branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the documentation site, and sync it to the S3 staging bucket.
Makefile Enhancements:
- Added a new target deploy-staging to deploy the documentation site to the staging environment.
- Updated the help section to include the new deploy-staging target.

These changes aim to improve the deployment process by ensuring that the latest version of Quarto is used and by providing a staging environment for testing documentation changes before they are pushed to production.

Test Suggestions

Verify that the production deployment workflow (deploy-docs-prod.yaml) successfully deploys the documentation site to the production S3 bucket.
Test the new staging deployment workflow (deploy-docs-staging.yaml) by pushing a commit to the staging branch and ensuring that the documentation site is correctly deployed to the staging S3 bucket.
Check that the Quarto installation step works as expected in both the production and staging workflows.
Ensure that the deploy-staging target in the Makefile correctly deploys the documentation site to the staging environment.
Validate that the rendered documentation site is free of errors by inspecting the render_errors.log file.

github-actions · 2024-09-03T22:07:32Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows for the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
Deploy Docs to Production:
- Added steps to download and install the latest Quarto release before rendering and deploying the documentation site.
- Improved the rendering step to capture and log errors if the Quarto render fails.
New Staging Deployment Workflow:
- Introduced a new workflow file (deploy-docs-staging.yaml) to deploy the documentation site to a staging environment whenever a commit is pushed to the specified branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the documentation site, and deploy it to the staging S3 bucket.
Makefile Enhancements:
- Added a new deploy-staging target to the Makefile to facilitate the deployment of the documentation site to the staging environment.
- Updated the help section to include the new deploy-staging target.

These changes aim to improve the robustness and flexibility of the CI/CD pipelines, making it easier to manage deployments across different environments.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the deployment to the production environment to ensure that the documentation site is rendered and deployed without errors.
Push a commit to the specified branch and verify that the new staging deployment workflow triggers and completes successfully.
Check the logs for the Quarto rendering step to ensure that errors are captured and logged correctly.
Run the deploy-staging target in the Makefile to confirm that it deploys the documentation site to the staging environment as expected.

github-actions · 2024-09-03T22:09:42Z

A PR preview is available: Preview URL

github-actions · 2024-09-03T22:13:11Z

A PR preview is available: Preview URL

github-actions · 2024-09-03T22:13:12Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows for the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names in the delete-pr-preview.yaml and validate-docs-site.yaml workflows to use hardcoded values instead of variables.
Production Deployment Workflow (deploy-docs-prod.yaml):
- Added steps to download and install the latest Quarto release.
- Added a step to render the documentation site using Quarto before deploying it to the production S3 bucket.
- Renamed the workflow and some steps for better clarity.
New Staging Deployment Workflow (deploy-docs-staging.yaml):
- Introduced a new workflow to deploy the documentation site to a staging S3 bucket whenever a commit is pushed to a specific branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the documentation site, and deploy it to the staging S3 bucket.
Makefile Enhancements (site/Makefile):
- Added a new deploy-staging target to the Makefile for deploying the documentation site to the staging S3 bucket.
- Updated the help section to include the new deploy-staging target.

These changes aim to improve the consistency, clarity, and functionality of the CI/CD workflows, as well as introduce a new staging environment for testing documentation site deployments.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the production deployment workflow to ensure that the documentation site is rendered and deployed correctly to the production S3 bucket.
Test the new staging deployment workflow by pushing a commit to the specified branch and verifying that the documentation site is deployed to the staging S3 bucket.
Run the deploy-staging target in the Makefile to ensure it works as expected.
Check that the AWS credentials are correctly configured and used in all workflows.

github-actions · 2024-09-03T22:21:59Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflows.
- Updated S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
Deploy Docs Site to Production:
- Added steps to download and install the latest Quarto release before rendering the docs site.
- Improved the rendering process with error logging.
- Updated the deployment step to sync the rendered site to the production S3 bucket and invalidate the CloudFront cache.
New Staging Deployment Workflow:
- Introduced a new workflow to deploy the docs site to a staging environment whenever a commit is pushed to a specific branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the docs site, and deploy it to the staging S3 bucket.
Makefile Enhancements:
- Added a new target deploy-staging to the Makefile for deploying the docs site to the staging environment.
- Updated the help section to include the new deploy-staging target.

These changes aim to improve the maintainability and functionality of the CI/CD pipelines, ensuring smoother deployments and better environment segregation.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the production deployment workflow to ensure the docs site is rendered and deployed correctly.
Test the new staging deployment workflow by pushing a commit to the specified branch and verifying the deployment.
Check the Makefile targets to ensure they execute the expected commands, especially the new deploy-staging target.
Ensure that the AWS credentials are correctly configured and used in both production and staging workflows.

github-actions · 2024-09-03T23:29:39Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows for the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names in the delete-pr-preview.yaml and validate-docs-site.yaml workflows to use hardcoded values instead of variables.
Deploy Docs to Production:
- Added steps to download and install the latest Quarto release before rendering the documentation site.
- Improved error handling for the Quarto render step.
- Renamed the workflow to 'Deploy docs site to production' for clarity.
New Staging Deployment Workflow:
- Introduced a new workflow deploy-docs-staging.yaml to deploy the documentation site to a staging environment whenever a commit is pushed to the nrichers/sc-6277/deploy-staging-docs-site-workflow branch.
- This workflow includes steps to check out the repository, download and install the latest Quarto release, render the documentation site, and deploy it to the staging S3 bucket.
Makefile Enhancements:
- Added a new deploy-staging target to the Makefile for deploying the documentation site to the staging environment.
- Updated the help section to include the new deploy-staging target.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the delete-pr-preview.yaml workflow to ensure it correctly deletes PR previews from the updated S3 bucket.
Run the deploy-docs-prod.yaml workflow to confirm that the documentation site is correctly rendered and deployed to the production S3 bucket.
Execute the new deploy-docs-staging.yaml workflow by pushing a commit to the specified branch and verify that the documentation site is deployed to the staging S3 bucket.
Check the Makefile deploy-staging target to ensure it correctly deploys the documentation site to the staging environment.

github-actions · 2024-09-04T00:51:09Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
Deploy Docs to Production:
- Added steps to download and install the latest Quarto release before rendering the docs site.
- Improved error handling during the Quarto render process.
- Renamed the workflow to 'Deploy docs site to production' for better clarity.
New Staging Deployment Workflow:
- Introduced a new workflow file deploy-docs-staging.yaml to deploy the docs site to a staging environment whenever a commit is pushed to the specified branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the docs site, configure AWS credentials, and deploy the site to the staging S3 bucket.
Makefile Enhancements:
- Added a new deploy-staging target to the Makefile for deploying the docs site to the staging environment.
- Updated the help section to include the new deploy-staging target.
Other Minor Fixes:
- Updated the delete-pr-preview.yaml workflow to use the correct S3 bucket name for deleting PR previews.
- Minor formatting and naming consistency improvements across various workflow files.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the production deployment workflow to ensure that the docs site is rendered and deployed correctly.
Push a commit to the specified branch and verify that the staging deployment workflow triggers and completes successfully.
Check the Makefile to ensure that the deploy-staging target works as expected.
Ensure that the PR preview deletion works correctly with the updated S3 bucket name.

github-actions · 2024-09-04T01:36:46Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names in delete-pr-preview.yaml and validate-docs-site.yaml to use explicit bucket names instead of variables.
Production Deployment Enhancements:
- Added steps to download and install the latest Quarto release in deploy-docs-prod.yaml.
- Improved the rendering process by capturing and displaying errors if the Quarto render fails.
- Renamed the workflow to 'Deploy docs site to production' for clarity.
Staging Deployment Workflow:
- Introduced a new workflow file deploy-docs-staging.yaml to handle deployments to a staging environment whenever changes are pushed to the staging branch.
- This workflow mirrors the production deployment process but targets a different S3 bucket and AWS region.
Makefile Updates:
- Added a new deploy-staging target to the Makefile to facilitate manual deployments to the staging environment.
- Updated the help section to include the new deploy-staging target.

These changes aim to improve the robustness and clarity of the CI/CD processes, as well as introduce a staging environment for safer deployments.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the production deployment workflow to ensure that the latest Quarto release is downloaded and installed correctly.
Ensure that the Quarto rendering process captures and displays errors as expected.
Test the new staging deployment workflow by pushing changes to the staging branch and verifying that the site is deployed to the correct S3 bucket.
Manually trigger the deploy-staging target in the Makefile and verify that it deploys the site to the staging environment correctly.

github-actions · 2024-09-04T01:40:29Z

A PR preview is available: Preview URL

github-actions · 2024-09-04T15:32:32Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Added steps to download and install the latest Quarto release in the deploy-docs-prod.yaml, deploy-docs-staging.yaml, and validate-docs-site.yaml workflows.
- Improved error handling for the Quarto render step to capture and display errors if the render fails.
Deployment to Staging:
- Introduced a new workflow file deploy-docs-staging.yaml to handle the deployment of the documentation site to a staging environment whenever a commit is pushed to the nrichers/sc-6277/deploy-staging-docs-site-workflow branch.
- Added a corresponding deploy-staging target in the Makefile to facilitate manual deployment to the staging environment.
AWS S3 and CloudFront Configuration:
- Updated the S3 bucket names and CloudFront distribution IDs in the delete-pr-preview.yaml, deploy-docs-prod.yaml, and validate-docs-site.yaml workflows to use the correct environment-specific values.
Miscellaneous:
- Minor formatting and consistency improvements across various workflow files.
- Updated the Makefile to include the new deploy-staging target in the help section.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Ensure that the Quarto installation step completes successfully in the deploy-docs-prod.yaml, deploy-docs-staging.yaml, and validate-docs-site.yaml workflows.
Test the Quarto render step to confirm that errors are captured and displayed correctly if the render fails.
Push a commit to the nrichers/sc-6277/deploy-staging-docs-site-workflow branch and verify that the documentation site is deployed to the staging environment.
Manually trigger the deploy-staging target in the Makefile and confirm that the deployment to the staging environment is successful.
Check that the S3 bucket names and CloudFront distribution IDs are correctly configured and that the deployment steps complete without errors.

github-actions · 2024-09-04T15:44:11Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows for the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
New Staging Deployment Workflow:
- Added a new GitHub Actions workflow (deploy-docs-staging.yaml) to deploy the documentation site to a staging environment whenever changes are pushed to the staging branch.
- This workflow includes steps to check out the repository, download and install the latest Quarto release, render the documentation site, configure AWS credentials, and deploy the site to the staging S3 bucket.
Production Deployment Workflow Enhancements:
- Updated the existing production deployment workflow (deploy-docs-prod.yaml) to include steps for downloading and installing the latest Quarto release and rendering the documentation site before deployment.
Makefile Updates:
- Added a new deploy-staging target to the Makefile to facilitate manual deployment of the documentation site to the staging environment.
Bug Fixes:
- Corrected the S3 bucket name in the delete-pr-preview.yaml and validate-docs-site.yaml workflows to ensure proper deletion and validation of PR previews.

These changes aim to improve the reliability and maintainability of the CI/CD pipelines, as well as introduce a clear separation between staging and production environments for the documentation site.

Test Suggestions

Verify that the new staging deployment workflow triggers correctly on pushes to the staging branch.
Ensure that the production deployment workflow still functions as expected after the enhancements.
Test the manual deploy-staging Makefile target to confirm it deploys the site to the correct S3 bucket and invalidates the CloudFront cache.
Check that the PR preview deletion and validation workflows correctly handle the updated S3 bucket names.
Validate that the Quarto installation and rendering steps work correctly in both the staging and production workflows.

github-actions · 2024-09-04T15:49:16Z

A PR preview is available: Preview URL

github-actions · 2024-09-04T15:55:58Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Added steps to download and install the latest Quarto release in the deploy-docs-prod.yaml, deploy-docs-staging.yaml, and validate-docs-site.yaml workflows.
- Improved error handling for the Quarto render step to capture and display errors if the render fails.
New Staging Deployment Workflow:
- Introduced a new workflow file deploy-docs-staging.yaml to deploy the documentation site to a staging environment whenever a commit is pushed to the staging branch.
- Configured AWS credentials specific to the staging environment and set the default region to us-west-2.
- Added a new Makefile target deploy-staging to facilitate the deployment of the documentation site to the staging environment.
Bucket Name Updates:
- Updated the S3 bucket names in delete-pr-preview.yaml and validate-docs-site.yaml to use the correct bucket names for the demo environment.
Makefile Enhancements:
- Added a new target deploy-staging to the Makefile for deploying the documentation site to the staging environment.

These changes aim to improve the robustness and flexibility of the CI/CD pipelines, ensuring smoother deployments and better error handling.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the new staging deployment workflow by pushing a commit to the 'staging' branch and ensuring the documentation site is deployed to the staging environment.
Check the Quarto render step to ensure it correctly captures and displays errors if the render fails.
Validate that the S3 bucket name updates in delete-pr-preview.yaml and validate-docs-site.yaml are correct and functional.
Run the deploy-staging target in the Makefile to ensure it deploys the documentation site to the staging environment as expected.

github-actions · 2024-09-04T22:47:23Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows for the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated the S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
New Staging Deployment Workflow:
- Added a new workflow file .github/workflows/deploy-docs-staging.yaml to handle the deployment of the documentation site to a staging environment.
- This workflow includes steps to check out the repository, download and install the latest Quarto release, render the documentation site, configure AWS credentials, and deploy the site to the staging S3 bucket.
Production Deployment Workflow Enhancements:
- Enhanced the existing production deployment workflow in .github/workflows/deploy-docs-prod.yaml by adding steps to download and install the latest Quarto release and render the documentation site before deploying it to the production S3 bucket.
Makefile Updates:
- Updated the Makefile to include a new target deploy-staging for deploying the documentation site to the staging environment.
- Added a corresponding help message for the new deploy-staging target.

These changes aim to improve the consistency, clarity, and functionality of the CI/CD workflows, as well as introduce a new staging environment for better testing and validation before production deployment.

Test Suggestions

Verify that the new staging deployment workflow triggers correctly on the specified branch.
Ensure that the documentation site is correctly rendered and deployed to the staging S3 bucket.
Test the production deployment workflow to confirm that the documentation site is rendered and deployed without errors.
Check that the AWS credentials are correctly configured and used in both staging and production workflows.
Validate that the CloudFront invalidation step works as expected in both staging and production deployments.

github-actions · 2024-09-04T22:51:21Z

A PR preview is available: Preview URL

validbeck

What's the worst that could happen

github-actions · 2024-09-04T23:03:20Z

PR Summary

This pull request introduces several enhancements and bug fixes to the CI/CD workflows of the project. The key changes are as follows:

General Workflow Improvements:
- Standardized the naming convention for the 'Check out repository' step across multiple workflow files.
- Updated S3 bucket names and CloudFront distribution IDs for better clarity and consistency.
Deploy Docs to Production:
- Added steps to download and install the latest Quarto release before rendering the docs site.
- Improved error handling during the Quarto render process.
New Staging Deployment Workflow:
- Introduced a new workflow file (deploy-docs-staging.yaml) to deploy the docs site to a staging environment whenever a commit is pushed to the staging branch.
- This workflow includes steps to check out the repository, download and install Quarto, render the docs site, configure AWS credentials, and deploy the site to the staging S3 bucket.
Makefile Enhancements:
- Added a new deploy-staging target to the Makefile for deploying the docs site to the staging environment.
- Updated the help section to include the new deploy-staging target.
Bug Fixes:
- Fixed minor issues in existing workflows, such as correcting the S3 bucket names and ensuring proper error handling during the Quarto render process.

Test Suggestions

Verify that the 'Check out repository' step works correctly in all workflows.
Test the new staging deployment workflow by pushing a commit to the staging branch and ensuring the docs site is deployed to the staging S3 bucket.
Ensure that the Quarto installation and rendering steps work as expected in both production and staging workflows.
Check that the AWS credentials are correctly configured and used in all workflows.
Validate that the S3 sync and CloudFront invalidation steps complete successfully in all workflows.

github-actions · 2024-09-04T23:09:26Z

A PR preview is available: Preview URL

* 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>

* 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>

* 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>

* 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>

Add new staging docs site deploy action and workflow

34d0e54

nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Sep 3, 2024

nrichers added 4 commits September 2, 2024 17:37

Change to PR branch for testing

65614e5

Change to PR branch for testing, take 2

6daedc4

Add quarto render steps to staging and prod workflows

80063bd

Minor wording fix

4d2994f

nrichers changed the title ~~Add new staging docs site deploy action and workflow~~ Add new staging docs site deploy and update prod deploy Sep 3, 2024

nrichers added 2 commits September 3, 2024 09:56

Minor wording tweaks

013f2ba

Merge branch 'main' of github.com:validmind/documentation into nrichers/

1a27b3a

sc-6277/deploy-staging-docs-site-workflow

Change to prod site for testing

f362dc6

Fix path issue in aws command, revert to correct branches

2d9f4b2

nrichers added 3 commits September 3, 2024 15:03

Remove some GitHub variables

1ee2e31

Switch staging deploy to new AWS access keys

e049b4d

Switch to PR branch for testing

703946f

Fix duplicate names

b3d18c1

Update bucket region info

d5fd81b

Formatting

d56e18e

Update Cloudfront info for staging and debug paths

1aa6a17

More path debugging

a3bc0b7

Change to PR branch for testing

c979921

nrichers added 2 commits September 4, 2024 08:42

Change back to staging branch

9fbf32b

Change to PR branch and docs-demo bucket for testing

75adf31

Change back to prod branch and prod bucket

a6c3f19

nrichers changed the title ~~Add new staging docs site deploy and update prod deploy~~ Add staging docs site deploy and update prod deploy Sep 4, 2024

nrichers mentioned this pull request Sep 4, 2024

Revamped Model Activity docs #315

Merged

nrichers requested a review from validbeck September 4, 2024 19:50

validbeck approved these changes Sep 4, 2024

View reviewed changes

nrichers force-pushed the nrichers/sc-6277/deploy-staging-docs-site-workflow branch from 6f13aaf to a6c3f19 Compare September 4, 2024 23:02

nrichers merged commit d69a03f into main Sep 4, 2024
19 checks passed

nrichers deleted the nrichers/sc-6277/deploy-staging-docs-site-workflow branch September 4, 2024 23:03

nrichers mentioned this pull request Sep 4, 2024

Delete site/_site directory in prod #328

Merged

validbeck mentioned this pull request Sep 9, 2024

Pushing changes from staging into prod #347

Merged

Add staging docs site deploy and update prod deploy #309

Add staging docs site deploy and update prod deploy #309

Uh oh!

Conversation

nrichers commented Sep 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal Notes for Reviewers

Proof it works

deploy-docs-staging.yaml

make deploy-staging

deploy-docs-prod.yaml

How to test

External Release Notes

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

Uh oh!

github-actions bot commented Sep 3, 2024

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 3, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Sep 4, 2024

Uh oh!

validbeck left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 4, 2024

nrichers commented Sep 3, 2024 •

edited

Loading

`deploy-docs-staging.yaml`

`make deploy-staging`

`deploy-docs-prod.yaml`