Improve workflows prerequisite info

site/_site/guide/preparing-validation-reports.html

@@ -693,7 +693,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-date-sort="1718834694000" data-listing-file-modified-sort="1718834694627" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="190">
+<div class="g-col-1" data-index="1" data-listing-date-sort="1718838387000" data-listing-file-modified-sort="1718838387400" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="190">
 <a href="../guide/review-model-documentation.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -749,7 +749,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="5" data-listing-date-sort="1718830987000" data-listing-file-modified-sort="1718830987829" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="195">
+<div class="g-col-1" data-index="5" data-listing-date-sort="1718838285000" data-listing-file-modified-sort="1718838285342" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="2" data-listing-word-count-sort="232">
 <a href="../guide/submit-for-approval.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">

site/_site/guide/submit-for-approval.html

@@ -544,17 +544,18 @@ <h1 class="title">Submit for approval</h1>
 <section id="prerequisites" class="level2">
 <h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
 <ul>
-<li>You hold the <code>Developer</code> role and are ready to submit your model documentation for review</li>
+<li>You hold the <code>Developer</code> role and are ready to submit your model documentation for reviewq</li>
 <li>You hold the <code>Validator</code> role and are ready submit their validation report for review</li>
 <li>The model you are documenting is registered in the model inventory</li>
+<li>The approval workflow has been configured by an administrator</li>
 </ul>
 <div class="callout callout-style-simple callout-important">
 <div class="callout-body d-flex">
 <div class="callout-icon-container">
 <i class="callout-icon"></i>
 </div>
 <div class="callout-body-container">
-<p>Workflow states and transitions can only be configured by an administrator.</p>
+<p>Workflow states and transitions can only be configured by an administrator. <a href="../guide/set-up-model-workflows.html">Learn more …</a></p>
 </div>
 </div>
 </div>
@@ -578,7 +579,7 @@ <h2 class="anchored" data-anchor-id="verify-the-workflow-and-view-current-status
 </section>
 <section id="advance-model-documentation-or-validation-reports-in-the-workflow" class="level2">
 <h2 class="anchored" data-anchor-id="advance-model-documentation-or-validation-reports-in-the-workflow">Advance model documentation or validation reports in the workflow</h2>
-<p>For you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.</p>
+<p>For you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required workflow steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.</p>
 <ol type="1">
 <li><p><a href="https://app.prod.validmind.ai">Log in to the ValidMind Platform UI</a>.</p></li>
 <li><p>In the left sidebar, click <a href="https://app.prod.validmind.ai/model-inventory"><strong>Model Inventory</strong></a>.</p></li>

site/_site/guide/working-with-model-documentation.html

@@ -787,7 +787,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="5" data-listing-date-sort="1718830987000" data-listing-file-modified-sort="1718830987829" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="1" data-listing-word-count-sort="195">
+<div class="g-col-1" data-index="5" data-listing-date-sort="1718838285000" data-listing-file-modified-sort="1718838285342" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="2" data-listing-word-count-sort="232">
 <a href="../guide/submit-for-approval.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">

site/_site/search.json

@@ -2924,7 +2924,7 @@
     "href": "training/training-for-model-developers.html#section-13",
     "title": "Training for Model Developers",
     "section": "",
-    "text": "When you’re ready, verify the approval workflow, and then submit your model documentation for approval.\n\n(Scroll down for the full instructions.)\n\nTry it live on the next page. \n\nFor you to be able to transition through the approval workflow, your model documentation must have completed all required steps.\n\nSelect a model by clicking on it or find your model by applying a filter or searching for it.\nIn the left sidebar that appears for your model, click Documentation.\nUnder Actions on the right, initiate the transition from the current state to the next workflow state.\nExamples:\n\nTo submit model documentation for validation: Click Ready for Validation to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation.\nTo submit validation reports for review and approval: Click Ready for Review to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit.\nTo request revisions to model documentation or validation reports: Click Request Revision, fill in the mandatory notes to explain the changes that are required, and submit.\nTo have your model documentation and validation report approved: Click Ready for Approval, fill in the mandatory notes, and submit.\n\n\n\n\nLearn more …",
+    "text": "When you’re ready, verify the approval workflow, and then submit your model documentation for approval.\n\n(Scroll down for the full instructions.)\n\nTry it live on the next page. \n\n\nVerify workflowSubmit for approval\n\n\nWorkflow states and transitions are configured by an administrator in advance, but you should verify that the expected people are included in the approval process.\n\nSelect a model by clicking on it or find your model by applying a filter or searching for it.\nIn the left sidebar that appears for your model, click Documentation.\nThe current status of the project is displayed under Document Status.\nFor example:\n\nIn Documentation means that the model is currently being documented and can be submitted for validation next.\nIn Validation means that the model is currently being validated and can be submitted for review and then approval.\n\nClick  See workflow to visualize the entire workflow that this model will go through.\n\n\n\nTo transition through the approval workflow, all required workflow steps must be completed. By default, a model must be in the In Documentation state before you can submit it for validation.\n\nSelect a model by clicking on it or find your model by applying a filter or searching for it.\nIn the left sidebar that appears for your model, click Documentation.\nUnder Actions on the right, initiate the transition from the current state to the next workflow state.\nExamples:\n\nTo submit model documentation for validation: Click Ready for Validation to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation.\nTo submit validation reports for review and approval: Click Ready for Review to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit.\nTo request revisions to model documentation or validation reports: Click Request Revision, fill in the mandatory notes to explain the changes that are required, and submit.\nTo have your model documentation and validation report approved: Click Ready for Approval, fill in the mandatory notes, and submit.\n\n\n\n\n\n\n\nLearn more …",
     "crumbs": [
       "Get Started",
       "For model developers"
@@ -4723,7 +4723,7 @@
     "href": "guide/submit-for-approval.html#prerequisites",
     "title": "Submit for approval",
     "section": "Prerequisites",
-    "text": "Prerequisites\n\nYou hold the Developer role and are ready to submit your model documentation for review\nYou hold the Validator role and are ready submit their validation report for review\nThe model you are documenting is registered in the model inventory\n\n\n\n\n\n\n\nWorkflow states and transitions can only be configured by an administrator.",
+    "text": "Prerequisites\n\nYou hold the Developer role and are ready to submit your model documentation for reviewq\nYou hold the Validator role and are ready submit their validation report for review\nThe model you are documenting is registered in the model inventory\nThe approval workflow has been configured by an administrator\n\n\n\n\n\n\n\nWorkflow states and transitions can only be configured by an administrator. Learn more …",
     "crumbs": [
       "Guides",
       "Working with model documentation",
@@ -4747,7 +4747,7 @@
     "href": "guide/submit-for-approval.html#advance-model-documentation-or-validation-reports-in-the-workflow",
     "title": "Submit for approval",
     "section": "Advance model documentation or validation reports in the workflow",
-    "text": "Advance model documentation or validation reports in the workflow\nFor you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.\n\nLog in to the ValidMind Platform UI.\nIn the left sidebar, click Model Inventory.\nSelect a model by clicking on it or find your model by applying a filter or searching for it.\nIn the left sidebar that appears for your model, click Documentation.\nUnder Actions on the right, initiate the transition from the current state to the next workflow state.\nExamples:\n\nTo submit model documentation for validation: Click Ready for Validation to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation.\nTo submit validation reports for review and approval: Click Ready for Review to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit.\nTo request revisions to model documentation or validation reports: Click Request Revision, fill in the mandatory notes to explain the changes that are required, and submit.\nTo have your model documentation and validation report approved: Click Ready for Approval, fill in the mandatory notes, and submit.",
+    "text": "Advance model documentation or validation reports in the workflow\nFor you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required workflow steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.\n\nLog in to the ValidMind Platform UI.\nIn the left sidebar, click Model Inventory.\nSelect a model by clicking on it or find your model by applying a filter or searching for it.\nIn the left sidebar that appears for your model, click Documentation.\nUnder Actions on the right, initiate the transition from the current state to the next workflow state.\nExamples:\n\nTo submit model documentation for validation: Click Ready for Validation to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation.\nTo submit validation reports for review and approval: Click Ready for Review to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit.\nTo request revisions to model documentation or validation reports: Click Request Revision, fill in the mandatory notes to explain the changes that are required, and submit.\nTo have your model documentation and validation report approved: Click Ready for Approval, fill in the mandatory notes, and submit.",
     "crumbs": [
       "Guides",
       "Working with model documentation",

site/_site/training/training-for-model-developers.html

@@ -739,7 +739,25 @@ <h2></h2>
 </div>
 <p><br>Try it <strong>live</strong> on the next page. <i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i></p>
 </div><div class="column bl pl4 f3" style="width:70%;">
-<p>For you to be able to transition through the approval workflow, your model documentation must have completed all required steps.</p>
+<div class="panel-tabset">
+<ul id="tabset-2" class="panel-tabset-tabby"><li><a data-tabby-default="" href="#tabset-2-1">Verify workflow</a></li><li><a href="#tabset-2-2">Submit for approval</a></li></ul>
+<div class="tab-content">
+<div id="tabset-2-1">
+<p>Workflow states and transitions are configured by an administrator in advance, but you should verify that the expected people are included in the approval process.</p>
+<ol type="1">
+<li><p>Select a model by clicking on it or find your model by applying a filter or searching for it.</p></li>
+<li><p>In the left sidebar that appears for your model, click <strong>Documentation</strong>.</p>
+<p>The current status of the project is displayed under <strong>Document Status</strong>.</p>
+<p>For example:</p>
+<ul>
+<li><code>In Documentation</code> means that the model is currently being documented and can be submitted for validation next.</li>
+<li><code>In Validation</code> means that the model is currently being validated and can be submitted for review and then approval.</li>
+</ul></li>
+<li><p>Click <strong><i class="fa-solid fa-arrow-right-arrow-left" aria-label="arrow-right-arrow-left"></i> See workflow</strong> to visualize the entire workflow that this model will go through.</p></li>
+</ol>
+</div>
+<div id="tabset-2-2">
+<p>To transition through the approval workflow, all required workflow steps must be completed. By default, a model must be in the <code>In Documentation</code> state before you can submit it for validation.</p>
 <ol type="1">
 <li><p>Select a model by clicking on it or find your model by applying a filter or searching for it.</p></li>
 <li><p>In the left sidebar that appears for your model, click <strong>Documentation</strong>.</p></li>
@@ -752,6 +770,9 @@ <h2></h2>
 <li><strong>To have your model documentation and validation report approved</strong>: Click <strong>Ready for Approval</strong>, fill in the mandatory notes, and submit.</li>
 </ul></li>
 </ol>
+</div>
+</div>
+</div>
 <form method="get" action="../guide/submit-for-approval.html" target="_blank">
 <button type="submit" style="color: white; background-color: #de257e; border-radius: 8px; border: none; font-size: 24px; padding: 6.25px 12.5px; margin-top: 10px; margin-bottom: 20px;">
 Learn more …

site/_site/training/training-for-model-validators.html

@@ -776,6 +776,7 @@ <h2></h2>
 <ul id="tabset-3" class="panel-tabset-tabby"><li><a data-tabby-default="" href="#tabset-3-1">Verify workflow</a></li><li><a href="#tabset-3-2">Submit for approval</a></li></ul>
 <div class="tab-content">
 <div id="tabset-3-1">
+<p>Workflow states and transitions are configured by an administrator in advance, but you should verify that the expected people are included in the approval process.</p>
 <ol type="1">
 <li><p>Select a model by clicking on it or find your model by applying a filter or searching for it.</p></li>
 <li><p>In the left sidebar that appears for your model, click <strong>Documentation</strong>.</p>
@@ -785,12 +786,11 @@ <h2></h2>
 <li><code>In Documentation</code> means that the model is currently being documented and can be submitted for validation next.</li>
 <li><code>In Validation</code> means that the model is currently being validated and can be submitted for review and then approval.</li>
 </ul></li>
-<li><p>Click <strong><i class="fa-solid fa-arrow-right-arrow-left" aria-label="arrow-right-arrow-left"></i> See workflow</strong> to visualize the entire workflow that this model will go through.</p>
-<p><img data-src="../guide/workflow.png" style="width:85.0%" alt="A summary view of the workflow steps that a model must go through, from initial documentation, to validation, review, and approval."></p></li>
+<li><p>Click <strong><i class="fa-solid fa-arrow-right-arrow-left" aria-label="arrow-right-arrow-left"></i> See workflow</strong> to visualize the entire workflow that this model will go through.</p></li>
 </ol>
 </div>
 <div id="tabset-3-2">
-<p>For you to be able to transition through the approval workflow, the model documentation and validation report must have completed all required steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.</p>
+<p>To transition through the approval workflow, all required workflow steps must be completed. For example, you cannot submit a validation report for review until the model documentation itself has been submitted.</p>
 <ol type="1">
 <li><p>Select a model by clicking on it or find your model by applying a filter or searching for it.</p></li>
 <li><p>In the left sidebar that appears for your model, click <strong>Documentation</strong>.</p></li>

site/guide/_submit_for_approval_verify.qmd

@@ -10,5 +10,3 @@
       - `In Validation` means that the model is currently being validated and can be submitted for review and then approval.
 
 1. Click **{{< fa arrow-right-arrow-left >}} See workflow** to visualize the entire workflow that this model will go through.
-
-   ![](../guide/workflow.png){width=85% fig-alt="A summary view of the workflow steps that a model must go through, from initial documentation, to validation, review, and approval."}

site/guide/submit-for-approval.qmd

@@ -7,12 +7,13 @@ When you're ready, verify the approval workflow, and then submit your model docu
 
 ## Prerequisites
 
-- You hold the `Developer` role and are ready to submit your model documentation for review
+- You hold the `Developer` role and are ready to submit your model documentation for reviewq
 - You hold the `Validator` role and are ready submit their validation report for review
 - The model you are documenting is registered in the model inventory
+- The approval workflow has been configured by an administrator
 
 ::: {.callout-important}
-Workflow states and transitions can only be configured by an administrator.
+Workflow states and transitions can only be configured by an administrator. [Learn more ...](set-up-model-workflows.qmd)
 :::
 
 ## Verify the workflow and view current status
@@ -23,9 +24,11 @@ Workflow states and transitions can only be configured by an administrator.
 
 {{< include _submit_for_approval_verify.qmd >}}
 
+   ![](../guide/workflow.png){width=85% fig-alt="A summary view of the workflow steps that a model must go through, from initial documentation, to validation, review, and approval."}
+
 ## Advance model documentation or validation reports in the workflow
 
-For you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted. 
+For you to be able to transition through the approval workflow, your model documentation or validation report must have completed all required workflow steps. For example, you cannot submit a validation report for review until the model documentation itself has been submitted. 
 
 1. [Log in to the {{< var vm_platform >}}]({{< var vm_url >}}).