Docs site audit accuracy tone review — Guides p1 by validbeck · Pull Request #377 · validmind/documentation

validbeck · 2024-09-17T19:56:13Z

Internal Notes for Reviewers

sc-4902

Cleaned up all the articles under "Guides" EXCEPT:

Work with content blocks
View reports

These need a more in-depth review so there are linked Stories to deal with those articles.

LIVE PREVIEW

Notable adjustments

Made sure casing & bolding matched style conventions
Added captions and missing alt tags to images
Reviewed step-by-step instructions for coherency and accuracy, made adjustments where necessary

github-actions · 2024-09-17T20:06:51Z

PR Summary

This pull request introduces several enhancements to the documentation and validation guidelines within the project. The key changes include:

Voice and Tone Updates: Improved inclusivity and accessibility by adding captions for images and refining alt text descriptions.
Glossary Enhancements: Updated the glossary to use em dashes for better readability.
Configuration Guide Improvements: Refined instructions for managing groups, roles, and users, including better formatting and clearer steps.
AWS and Google PrivateLink Configuration: Added detailed alt text for images and improved the clarity of instructions.
Dashboard Customization: Enhanced instructions for adding and removing report widgets on the dashboard.
Model Documentation and Validation: Improved the process for customizing documentation templates, assigning section statuses, and collaborating with others through comments and revision history.
Model Inventory Management: Added steps for archiving and deleting models, configuring model interdependencies, and customizing the model inventory layout.
Model Validation: Enhanced the process for assessing compliance, linking evidence and findings, and managing validation guidelines.
Monitoring: Improved instructions for enabling and reviewing ongoing monitoring results.
Training Guides: Updated training guides for model developers and validators to include new collaboration features.

These changes aim to improve the overall usability, accessibility, and clarity of the documentation and validation processes.

Test Suggestions

Verify that all updated documentation sections render correctly and are free of formatting issues.
Test the new instructions for managing groups, roles, and users to ensure they are clear and accurate.
Check the updated alt text for images in the AWS and Google PrivateLink configuration guides to ensure they are descriptive and accurate.
Validate the process for customizing documentation templates and assigning section statuses to ensure it works as described.
Test the new collaboration features, including commenting and revision history, to ensure they function correctly.
Verify that the steps for archiving and deleting models in the model inventory are accurate and work as expected.
Check the process for assessing compliance and linking evidence and findings to ensure it is clear and functional.
Test the instructions for enabling and reviewing ongoing monitoring results to ensure they are accurate and easy to follow.
Review the training guides for model developers and validators to ensure they include the new collaboration features and are easy to understand.

nrichers

LGTM! Just some minor stuff, plus some exuberant appreciation for {.smallcaps}.

site/guide/configuration/_manage-roles.qmd

site/guide/configuration/configure-aws-privatelink.qmd

site/guide/model-documentation/collaborate-with-others.qmd

Co-authored-by: Nik Richers <[email protected]>

github-actions · 2024-09-17T21:55:14Z

A PR preview is available: Preview URL

github-actions · 2024-09-17T21:55:33Z

A PR preview is available: Preview URL

github-actions · 2024-09-17T21:57:09Z

A PR preview is available: Preview URL

* 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 * Update site/guide/model-documentation/collaborate-with-others.qmd * Quick tweak --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* 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 <[email protected]> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak --------- Co-authored-by: Nik Richers <[email protected]> * Run make get-source --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* 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 * Update site/guide/model-documentation/collaborate-with-others.qmd * Quick tweak --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]>

* 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 <[email protected]> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak --------- Co-authored-by: Nik Richers <[email protected]> * Update README.md --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* 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 <[email protected]> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak --------- Co-authored-by: Nik Richers <[email protected]> * Update README.md * Run make get-source (#398) --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* 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 <[email protected]> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak --------- Co-authored-by: Nik Richers <[email protected]> * Update README.md * Run make get-source (#398) --------- Co-authored-by: Beck <[email protected]> Co-authored-by: Nik Richers <[email protected]>

* 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 <[email protected]> * Update site/guide/configuration/manage-your-profile.qmd Co-authored-by: Nik Richers <[email protected]> * Bolded compliance assessments --------- Co-authored-by: Nik Richers <[email protected]> * 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 <[email protected]> --------- Co-authored-by: Nik Richers <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Edited the other front matter ref --------- Co-authored-by: Nik Richers <[email protected]> * Adding new ValidMind colors & logo (#366) * Start adding updated ValidMind colors & logo * Bit more of that lovely green * Prereq tweak --------- Co-authored-by: Beck <[email protected]> * 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 <[email protected]> * Update site/guide/model-documentation/collaborate-with-others.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak --------- Co-authored-by: Nik Richers <[email protected]> * 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 <[email protected]> * Adjusted casing for report widgets --------- Co-authored-by: Nik Richers <[email protected]> * 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 <[email protected]> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <[email protected]> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <[email protected]> * Update site/guide/configuration/register-with-validmind.qmd Co-authored-by: Nik Richers <[email protected]> * Tweaks --------- Co-authored-by: Nik Richers <[email protected]> --------- 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 <[email protected]>

validbeck added 30 commits September 13, 2024 12:30

Edits to swap docs templates

0e555e9

Added ongoing monitoring to swap templates

2bfaa23

Cleaned up guides.qmd

8348ac3

Cleaned up log-in-to-validmind.qmd

4392887

Cleaned up set-up-your-organization.qmd

2bcb17f

Cleaned up configure-google... .qmd

034ee21

Cleaned up managing-users .qmd

9f73165

Cleaned up manage-users.qmd

3732f49

Cleaned up manage-groups.qmd

330048b

Cleaned up manage-roles.qmd

66ce90f

Cleaned up manage-your-profile.qmd

e87ee5c

Cleaned up customize-your-dashboard.qmd

ab5cf21

Cleaned up working-with-model-workflows.qmd

b448c55

Cleaned up customize-model-lifecycle-statuses.qmd

88a1b9d

Cleaned up set-up-model-workflows.qmd

2783155

Cleaned up working-with-model-inventory.qmd

1ead1eb

Cleaned up register-models-in-inventory.qmd

cbea5fc

Cleaned up customize-model-inventory-layout.qmd

93746f3

Cleaned up edit-model-inventory-fields.qmd

544cb39

Cleaned up view-model-activity.qmd

22aa8f7

Cleaned up configure-model-interdependencies.qmd

44c2aae

Cleaned up manage-model-inventory-fields.qmd

0e91ec2

Tweaks for model stage columns

7d22b0e

Cleaned up view-documentation-templates.qmd

a615dc8

Cleaned up customize-documentation-templates.qmd

3ad8b73

Cleaned up swap-documentation-templates.qmd

c87a140

Cleaned up assign-documentation-section-statuses.qmd

3934a24

Cleaned up submit-for-approval.qmd

4667346

Cleaned up export-documentation.qmd

e677fe7

Cleaned up collaborate-with-others.qmd

f411090

validbeck added 8 commits September 17, 2024 12:14

Cleaned review-monitoring-results.qmd

0c93718

Final tweaks

22df74a

Captions added to configuration/

4d28a25

Captions added to model-workflows/

b63b1f0

Captions added to model-inventory/

cbccb21

Captions added to model-documentation/

bba4ea4

Captions added to model-validation/

8189a97

Captions added to monitoring/

d7b1892

validbeck added the internal Not to be externalized in the release notes label Sep 17, 2024

validbeck self-assigned this Sep 17, 2024

validbeck requested a review from nrichers September 17, 2024 20:06

nrichers approved these changes Sep 17, 2024

View reviewed changes

validbeck and others added 3 commits September 17, 2024 14:48

Update site/guide/configuration/configure-aws-privatelink.qmd

5269054

Co-authored-by: Nik Richers <[email protected]>

Update site/guide/model-documentation/collaborate-with-others.qmd

2035d97

Co-authored-by: Nik Richers <[email protected]>

Quick tweak

cac65a0

validbeck merged commit bd6957b into main Sep 17, 2024

validbeck deleted the beck/sc-4902/docs-site-audit-accuracy-tone-review branch September 17, 2024 21:58

validbeck mentioned this pull request Sep 20, 2024

Publishing changes from PR #359 onwards #421

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs site audit accuracy tone review — Guides p1#377

Docs site audit accuracy tone review — Guides p1#377
validbeck merged 47 commits intomainfrom
beck/sc-4902/docs-site-audit-accuracy-tone-review

validbeck commented Sep 17, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

nrichers left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

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

Uh oh!

Internal Notes for Reviewers

Notable adjustments

Uh oh!

github-actions bot commented Sep 17, 2024

PR Summary

Test Suggestions

Uh oh!

nrichers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

github-actions bot commented Sep 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

validbeck commented Sep 17, 2024 •

edited

Loading