quickstart: Model Development (#748)

* Setup for new developer quickstart

* Save point

* Save point

* Cleanup of old quickstart files

* Proofreading

* Single-sourcing common steps

* Proofreading

* Broken link cleanup

* Editing

* Tweak

* Edit

* Final edit for now

* I lied one more

* Notes & adjust

* Oops forgot to comment out a line

* Tweak

* Tweakkk

* Forgot aliases, quick adjust

Author: validbeck

README.md

@@ -106,7 +106,7 @@ When constructing links, refer to the `.qmd` file as Quarto will properly render
 
 | Correct | Incorrect |
 |---|---|
-| `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.qmd)` | `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.html)` |
+| `[Quickstart — Model Development](get-started/developer/quickstart-developer.qmd)` | `[Quickstart — Model Development](get-started/developer/quickstart-developer.html)` |
 
 When constructing filepaths, including while using [Quarto's Includes](https://quarto.org/docs/authoring/includes.html) (single-sourcing feature), you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths: 
 

site/about/overview-model-documentation.qmd

@@ -9,9 +9,9 @@ listing:
   grid-columns: 2
   # image-height: 100%
   contents:
-    - path: ../get-started/quickstart.qmd
-      title: "QuickStart"
-      description: "Our QuickStart is the quickest and easiest way to try out our product features."
+    - path: ../get-started/get-started.qmd
+      title: "Get started"
+      description: "Our quickstarts are the quickest and easiest way to try out our product features."
   fields: [title, description, reading-time]
 ---
 

site/about/overview-model-risk-management.qmd

@@ -9,9 +9,9 @@ listing:
   grid-columns: 2
   # image-height: 100%
   contents:
-    - path: ../get-started/quickstart.qmd
-      title: "QuickStart"
-      description: "Our QuickStart is the quickest and easiest way to try out our product features."
+    - path: ../get-started/get-started.qmd
+      title: "Get started"
+      description: "Our quickstarts are the quickest and easiest way to try out our product features."
   fields: [title, description, reading-time]
 ---
 

site/developer/validmind-library.qmd

@@ -1,5 +1,6 @@
 ---
-title: "{{< var validmind.developer >}}"
+# USING THE VARIABLE MESSES UP THE SPACING ON THE PREVIEW TILE
+title: "ValidMind Library"
 date: last-modified
 aliases:
   - /guide/get-started-developer-framework.html
@@ -84,7 +85,7 @@ listing:
     - ../guide/model-documentation/work-with-content-blocks.qmd
 ---
 
-The {{< var validmind.developer >}} helps you streamline model documentation by automating the generation of drafts. All you need to do is upload your documentation artifacts and test results to the {{< var validmind.platform >}}.
+The {{< var validmind.developer >}} streamlines model development and validation by automating testing. Run tests, log those test results to the {{< var validmind.platform >}}, and have fully supported drafts of documentation or reporting ready for you to fine-tune.
 
 ## What is the {{< var validmind.developer >}}?
 

site/get-started/_sidebar.yaml

@@ -4,9 +4,9 @@ website:
       title: "Get Started"
       contents:
         - text: "Quickstart For"
-        - text: "Model development"
+        - text: "Model Development"
           file: get-started/developer/quickstart-developer.qmd
-        - text: "Model validation"
+        - text: "Model Validation"
           file: get-started/validator/quickstart-validator.qmd
-        - text: "Setup & administration"
+        - text: "Setup & Administration"
           file: get-started/administrator/quickstart-administrator.qmd

site/get-started/administrator/quickstart-administrator.qmd

@@ -4,4 +4,27 @@ date: last-modified
 page-layout: full
 ---
 
-Set up your organization, onboard new users, and set up user roles, permissions, and groups within the {{< var validmind.platform >}} as a superuser.
+Set up the foundational units for your organization within the {{< var validmind.platform >}}, prepare your organization for users, then grant access to your first user.
+
+<!-- BECK'S OUTLINE / NOTES -->
+
+<!-- {{< include /get-started/common-assets/_before-you-begin.qmd >}}
+
+## Setting up your organization
+
+### Set up business units
+
+### Set up use cases
+
+## Preparing your organization for users
+
+### Set up groups
+
+### Set up roles
+
+## Invite your first user
+
+## What's next
+
+- Administrator Fundamentals
+- ValidMind Platform Guides -->

site/get-started/common-assets/_access-quickstart-notebook.qmd

@@ -0,0 +1,7 @@
+### Access the quickstart notebook
+
+You can either load the hosted version of our notebook, or download the notebook to run in your own local environment:
+
+#### Load the hosted notebook (recommended)
+
+1. Sign in to [JupyterHub]({{< var url.jupyterhub >}}) with your {{< var vm.product >}} login.

site/get-started/common-assets/_before-you-begin.qmd

@@ -0,0 +1,8 @@
+::: {.attn}
+
+## {{< fa star-of-life >}} Before you begin
+
+- [x] To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}.[^1]
+- [x] You'll also want to make sure that you're logged into the {{< var validmind.platform >}}.[^2]
+
+:::

site/get-started/common-assets/_download-code-samples.qmd

@@ -0,0 +1,7 @@
+##### Option 2: Download the code samples
+
+1. Download our selection of code samples: [`notebooks.zip`](/notebooks.zip)
+
+1. Navigate to the location where you saved `notebooks.zip` and extract the contents.^[Depending on your operating system, you can right-click on `notebooks.zip` and select **Extract All ...** or **Extract Here**, for example.]
+
+1. Navigate to the folder where you extracted the files.

site/get-started/common-assets/_download-notebooks.qmd

@@ -0,0 +1,12 @@
+#### Download the notebooks
+
+##### Option 1: Clone the GitHub repository
+
+1. Open a terminal or command prompt.
+
+1. Navigate to the directory where you want to clone the repository.
+
+1. Run the following command:
+   ```bash
+   git clone https://github.com/validmind/validmind-library.git
+   ```

site/get-started/common-assets/_get-your-code-snippet.qmd

@@ -0,0 +1,7 @@
+#### Get your code snippet
+
+Before we move on, let's also retrieve the unique *code snippet* for your model that will enable you to connect your testing environment with the correct model in the {{< var validmind.platform >}}:
+
+1. In the left sidebar that appears for your model, click **{{< fa rocket >}} Getting Started**.
+
+1. Locate the code snippet and click **{{< fa regular copy >}} Copy snippet to clipboard**.

site/get-started/common-assets/_register-your-first-model.qmd

@@ -0,0 +1,11 @@
+1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
+
+1. Click **{{< fa plus >}} Register New Model**.
+
+1. To register a model for use with this quickstart, select:
+
+   - [what type of model is it?]{.smallcaps} — `New Model`
+   - [template]{.smallcaps} — `Binary classification`
+   - [use case]{.smallcaps} — `Attrition/Churn Management`
+
+1. Click **Register Model** to add the model to your inventory.

site/get-started/common-assets/_run-quickstart-notebook.qmd

@@ -0,0 +1,17 @@
+### Run the quickstart notebook
+
+::: {.callout title="Do you have your code snippet?"}
+
+To initialize the {{< var validmind.developer >}} which connects your environment to the correct model in the {{< var validmind.platform >}}, you'll need your unique code snippet!^[[Get your code snippet](#get-your-code-snippet)]
+:::
+
+1. Follow the instructions to run the first two code cells in the notebook,[^longnote] which will set the stage by installing and initializing {{< var vm.product >}}.^[[Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd)]
+
+1. Under the cell at bottom of the **Get your code snippet** section, confirm that you see a success message verifying that you've connected to the right model.
+
+   This message verifies that the {{< var vm.developer >}} works as expected as is connected to the correct model within the {{< var vm.platform >}}. 
+
+[^longnote]:
+
+   - Hover over each cell and click the {{< fa circle-play >}} **icon**; OR
+   - Press `Shift + Enter` on Windows or `Cmd + Enter` if you are on a Mac

site/get-started/developer/developer-code-snippet.png

@@ -2,65 +2,132 @@
 title: "Quickstart — Model Development"
 date: last-modified
 page-layout: full
+listing:
+  - id: whats-next
+    type: grid
+    grid-columns: 2
+    max-description-length: 250
+    sort: false
+    fields: [title, description]
+    contents:
+    - ../../training/developer-fundamentals/developer-fundamentals-register.qmd
+    - ../../developer/validmind-library.qmd
+aliases: 
+  - try-with-jupyterhub.html
+  - try-with-colab.html
+  - try-in-your-own-environment.html
+  - ../platform/explore-sample-model-documentation.html
+  - ../platform/register-your-first-model.html
+  - ../platform/generate-documentation-for-your-model.html
 ---
 
-Register your first model, use the {{< var validmind.developer >}} to document a model and run tests, and edit your generated model documentation using the {{< var validmind.platform >}}.
+Register your first model, use the {{< var validmind.developer >}} to run tests and document a model, then review your generated model documentation within the {{< var validmind.platform >}}.
 
-<!-- THIS IS THE OLD INFO AS A PLACEHOLDER, NEW INFO TO COME -->
+{{< include /get-started/common-assets/_before-you-begin.qmd >}}
 
-::: {.attn}
+## Register your first model
 
-## {{< fa star-of-life >}} Before you begin
+The first step to using {{< var vm.product >}} to develop models is to register them in your model inventory:
 
-To try out {{< var vm.product >}}, you need to be a registered user on the {{< var validmind.platform >}}.
+{{< include /get-started/common-assets/_register-your-first-model.qmd >}}
 
-::: {.callout}
-## Need an account for {{< var vm.product >}}?
-Signing up is FREE — {{< var link.register >}} 
+::: {.column-margin}
+![Registration modal with the options filled out for the model development quickstart](developer-new-model.png){width=90% fig-alt="A screenshot showing the registration modal with the options filled out for the model development quickstart" .screenshot}
 :::
 
+{{< include /get-started/common-assets/_get-your-code-snippet.qmd >}}
+
+::: {.column-margin}
+![{{< fa rocket >}} Getting Started page with a sample code snippet](developer-code-snippet.png){width=90% fig-alt="A screenshot showing the Getting Started page with a sample code snippet" .screenshot}
 :::
 
-## Steps
+## Using the {{< var validmind.developer >}}
+
+Next, let's set up the {{< var validmind.developer >}} in your developer environment of choice so we can use it to run and log tests, which will help automate the documentation of your models.
+
+Our companion notebook, **Quickstart for model documentation,**[^3] will walk you through the steps of installing the {{< var vm.developer >}} in your environment, initializing the {{< var vm.developer >}} for use, and running a full suite of documentation tests that will log the results to the {{< var validmind.platform >}}.
+
+{{< include /get-started/common-assets/_access-quickstart-notebook.qmd >}}
+
+<!-- NOT LIVE ON JUPYTERHUB YET, HASN'T BEEN UPDATED -->
+1. Open [Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb) and [run the quickstart notebook](#run-the-quickstart-notebook).
+
+{{< include /get-started/common-assets/_download-notebooks.qmd >}}
+
+1. After the cloning process is complete, open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the quickstart notebook](#run-the-quickstart-notebook).
+
+{{< include /get-started/common-assets/_download-code-samples.qmd >}}
+
+1. Open `notebooks/quickstart/quickstart_model_documentation.ipynb` in your developer environment and [run the quickstart notebook](#run-the-quickstart-notebook).
+
+{{< include /get-started/common-assets/_run-quickstart-notebook.qmd >}}
+
+::: {.column-margin}
+**Example success message:**
+
+```bash
+2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}!
+📊 Model: [ValidMind] Model development quickstart (ID: cmalgf3qi02ce199qm3rdkl46)
+📁 Document Type: model_documentation
+```
+:::
+
+3. Continue running the rest of the notebook to automatically populate test results for your sample model to your documentation for that model in the {{< var vm.platform >}}.
+
+## Work with model documentation
 
-1. In a web browser, open [Quickstart for model documentation]({{< var url.jupyterhub >}}/hub/user-redirect/lab/tree/quickstart/quickstart_model_documentation.ipynb).
+After you successfully run the notebook, return to the {{< var validmind.platform >}}:
 
-   This link takes you to {{< var vm.product >}}'s JupyterHub instance where you can log in with the Auth0 credentials for your {{< var vm.product >}} account to access the **QuickStart for model documentation** notebook:
+1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
 
-   ![QuickStart notebook opened in JupyterHub](jupyterhub-dashboard.png){width=90% fig-alt="A screenshot showing the QuickStart notebook opened in JupyterHub" .screenshot}
+2. Locate or search for the model you registered for this quickstart and click on it to select it.[^4]
 
-   The notebook will guide you through installing the {{< var validmind.developer >}}, initializing the Python environment, and finally connecting the {{< var vm.developer >}} to the {{< var validmind.platform >}}.
+3. In the left sidebar that appears for the model, click **{{< fa book-open >}} Documentation**.
 
-2. Follow the instructions to run the first two code cells in the notebook, which will set the stage by installing and initializing {{< var vm.product >}}:[^1]
+   - Your model's documentation is broken down into sections, defined by your documentation templates.[^5]
+   - Each section can be assigned a completion status,[^6] allowing you to track the progress of your documentation.
 
-   - Hover over each cell and click the {{< fa circle-play >}} **icon**; OR
-   - Press `Shift + Enter` on Windows or `Cmd + Enter` if you are on a Mac
-   
-   Under the cell at bottom of the **Initialize the ValidMind Library** section, confirm that you see a success message that looks something like this:
-   
-   ```bash
-   2024-10-08 22:06:42,610 - INFO(validmind.api_client): 🎉 Connected to {{< var vm.product >}}!
-   📊 Model: [Demo] Customer Churn Model (ID: clwqy70qd01my22ikc49paar9)
-   📁 Document Type: model_documentation
-   ```
-   
-   This message verifies that the {{< var vm.developer >}} works as expected as is connected to the correct model within the {{< var vm.platform >}}. 
+4. Click on any section of the documentation to review the test results and drafts of test result summaries generated by the {{< var validmind.developer >}}.
 
-You can now continue running the rest of the cells if you want to see how the demo notebook works or, to save some time, you can move on to the [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to explore the {{< var vm.platform >}}.  
+   In any subsection, expand the **{{< var vm.product >}} Insights™** panel to view the Documentation Guidelines[^7] that tell you more about what these sections mean and help you with the task of documenting the model as a developer.
 
-#### Watch the tutorial
+:::: {.flex .flex-wrap .justify-around}
 
-Need more help? Experience this guide in video format:
+::: {.w-40-ns .tc}
 
-{{< video https://www.youtube.com/embed/rIR8Mql7eGs?si=vnZA_zP4tAjFjI4r title='ValidMind QuickStart' >}}
+![Example model details page with documentation outline](developer-model-details.png){width=90% fig-alt="A screenshot showing an example model details page with documentation outline" .screenshot group="documentation"}
+
+:::
+
+::: {.w-40-ns .tc}
+
+![Populated model documentation section with the **{{< var vm.product >}} Insights™** panel open](validmind-insights.png){width=90% fig-alt="A screenshot showing populated model documentation section with the ValidMind Insights™ panel open" .screenshot group="documentation"}
+
+:::
+
+::::
 
-<!--- TO DO Screenshot --->
 
 ## What's next
 
-Continue with [Explore sample model documentation](/get-started/platform/explore-sample-model-documentation.qmd) to learn more about using the {{< var validmind.platform >}} hands-on.
+Now that you've grasped the basics of using {{< var vm.product >}} for model development, continue on your journey with our end-to-end training course for developers and browse through our resource hub for the {{< var validmind.developer >}}:
+
+:::{#whats-next}
+:::
 
 
 <!-- FOOTNOTES -->
 
-[^1]: [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd)
+[^1]: [Register with {{< var vm.product >}}](/guide/configuration/register-with-validmind.qmd)
+
+[^2]: [Log in to {{< var vm.product >}}](/guide/configuration/log-in-to-validmind.qmd)
+
+[^3]: [Quickstart for model documentation](/notebooks/quickstart/quickstart_model_documentation.ipynb)
+
+[^4]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
+
+[^5]: [Working with documentation templates](/guide/templates/working-with-documentation-templates.qmd)
+
+[^6]: [Assign documentation section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd)
+
+[^7]: [View documentation guidelines](/guide/model-documentation/view-documentation-guidelines.qmd)