Established variable naming conventions

site-unused/qmd/before-you-begin.qmd

@@ -10,16 +10,16 @@ Signing up is FREE — **[Create your account]({{< var vm_url >}})**.
 :::
 
 
-To try out ValidMind, you need to be a registered user on the {{< var vm_platform >}}.
+To try out ValidMind, you need to be a registered user on the {{< var validmind_platform >}}.
 
-To connect the {{< var vm_framework >}} to the {{< var vm_platform >}} and to access the web user interface, you must be able to access our domains:
+To connect the {{< var validmind_developer >}} to the {{< var validmind_platform >}} and to access the web user interface, you must be able to access our domains:
 
 - validmind.ai
 - validmind.com
 
 If necessary, ask a network administrator to add these domains to your firewall allowlist (whitelist). 
 
-If your company has strict security requirements and requires you to connect via VPN or AWS PrivateLink, please contact your IT/InfoSec team. For additional help setting up a VPN or PrivateLink with the {{< var vm_risk >}} please visit [configure AWS PrivateLink](configure-aws-privatelink.qmd) or send an email to <support@validmind.ai>.
+If your company has strict security requirements and requires you to connect via VPN or AWS PrivateLink, please contact your IT/InfoSec team. For additional help setting up a VPN or PrivateLink with the {{< var risk_platform >}} please visit [configure AWS PrivateLink](configure-aws-privatelink.qmd) or send an email to <support@validmind.ai>.
 
 ### QuickStart requirements
 
@@ -29,13 +29,13 @@ To follow the QuickStart, you need access to ONE of the following:
 - [Google Colaboratory (Colab)](try-with-colab.qmd)
 - [Docker Desktop](quickstart-try-developer-framework-with-docker.qmd)
 
-To run our sample Jupyter Notebooks locally, your developer environment must support **Python {{< var python-version >}}**.
+To run our sample Jupyter Notebooks locally, your developer environment must support **Python {{< var python_version >}}**.
 
 ### Access to ValidMind's Web UI
 
 You need to be able to access our ValidMind Web UI from a modern browser such as Microsoft Edge, Google Chrome, Apple Safari, or Mozilla Firefox.
 
 ## What's next
 
-Continue with Explore the {{< var vm_dev >}}. We recommend using [JupyterHub](try-with-jupyterhub.qmd). 
+Continue with Explore the {{< var developer >}}. We recommend using [JupyterHub](try-with-jupyterhub.qmd). 
 

site-unused/qmd/create-documentation.qmd

@@ -41,7 +41,7 @@ ValidMind has now created an empty documentation project associated with the mod
 - `api_secret`: The account secret key
 - `project`: The project identifier
 
-The code snippet can be copied and pasted directly into your developer source code to integrate the {{< var vm_framework >}} and to be able to upload to the {{< var vm_platform >}}.
+The code snippet can be copied and pasted directly into your developer source code to integrate the {{< var validmind_developer >}} and to be able to upload to the {{< var validmind_platform >}}.
 
 <!---
 ## Troubleshooting
@@ -51,6 +51,6 @@ The code snippet can be copied and pasted directly into your developer source co
 
 ## What's next
 
-- [Get started with the {{< var vm_framework >}}](get-started-developer-framework.qmd)
-- [Install and initialize the {{< var vm_dev >}}](install-and-initialize-developer-framework.qmd)
+- [Get started with the {{< var validmind_developer >}}](get-started-developer-framework.qmd)
+- [Install and initialize the {{< var developer >}}](install-and-initialize-developer-framework.qmd)
 - [Working with model documentation](working-with-model-documentation.qmd)

site-unused/qmd/developer-getting-started-video.qmd

@@ -4,6 +4,6 @@ date: last-modified
 search: false
 ---
 
-[A video walkthrough for the {{< var vm_dev >}} experience that matches what we show in the QuickStart.]
+[A video walkthrough for the {{< var developer >}} experience that matches what we show in the QuickStart.]
 
 A 3-minute video that walks you through documenting a model with ValidMind.

site-unused/qmd/editions-and-features.qmd

@@ -9,7 +9,7 @@ ValidMind offers its solution in multiple editions to choose from. Each edition
 
 ### Developer Edition
 
-The Developer Edition is the ideal training ground for developers to play around with ValidMind's automated model documentation and to test the robustness of our {{< var vm_dev >}}, documentation, and testing features. The Developer Edition is free, allowing developers who are new to model documentation and model risk management to build, implement, test, and maintain higher quality models and model documentation. 
+The Developer Edition is the ideal training ground for developers to play around with ValidMind's automated model documentation and to test the robustness of our {{< var developer >}}, documentation, and testing features. The Developer Edition is free, allowing developers who are new to model documentation and model risk management to build, implement, test, and maintain higher quality models and model documentation. 
 
 The Developer Edition is only for personal testing purposes and cannot be used as a commercial model documentation or model risk management solution.
 
@@ -28,7 +28,7 @@ Provides the highest level of security for organizations requiring a stricter tr
 | **Model development & documentation**             | Developer           | Essential           | Business Critical   |
 |---------------------------------------------------|:-------------------:|:-------------------:|:-------------------:|
 | Automated model documentation                     | {{< fa check >}}    | {{< fa check >}}    | {{< fa check >}}    |
-| Platform-independent {{< var vm_dev >}}          | {{< fa check >}}    | {{< fa check >}}    | {{< fa check >}}    |
+| Platform-independent {{< var developer >}}          | {{< fa check >}}    | {{< fa check >}}    | {{< fa check >}}    |
 | Online documentation editing                      | {{< fa check >}}    | {{< fa check >}}    | {{< fa check >}}    |
 | Advanced editing & readability assistance         |                     | {{< fa check >}}    | {{< fa check >}}    |
 | Documentation quality measurement                 |                     | {{< fa check >}}    | {{< fa check >}}    |
@@ -62,7 +62,7 @@ Provides the highest level of security for organizations requiring a stricter tr
 | Multi-tenant SaaS                                 | {{< fa check >}}    | {{< fa check >}}    | {{< fa check >}}    |
 | Virtual private ValidMind (VPV)                   |                     | {{< fa check >}}    | {{< fa check >}}    |
 | Self-managed VPV                                  |                     |                     | {{< fa check >}}    |
-|                                                   | {{< var contact >}} | {{< var contact >}} | {{< var contact >}} |
+|                                                   | {{< var vm_contact >}} | {{< var vm_contact >}} | {{< var vm_contact >}} |
 
 <!---| AI-generated guidelines & recommendations on<br>documentation compliance and potential model risks | | | {{< fa check >}}    | --->
 

site-unused/qmd/faq-data-handling.qmd

@@ -11,7 +11,7 @@ ValidMind provides a built-in user management interface that allows new users to
 
 ## Does ValidMind handle large datasets?
 
-The {{< var vm_dev >}} executes test suites and functions locally in your environment and is not limited by dataset size. 
+The {{< var developer >}} executes test suites and functions locally in your environment and is not limited by dataset size. 
 
 ##  What about the confidentiality of data sent to ValidMind?
 
@@ -25,17 +25,17 @@ Support for more complex data processing pipelines is on our roadmap. We are imp
 
 ## How does the tool manage model changes?
 
-ValidMind allows model developers to re-run documentation functions with the {{< var vm_dev >}} to capture changes in the model, such as changes in the number of features or hyperparameters.
+ValidMind allows model developers to re-run documentation functions with the {{< var developer >}} to capture changes in the model, such as changes in the number of features or hyperparameters.
 
 After a model developer makes a change in their development environment, such as in a Jupyter notebook, they can execute the relevant ValidMind documentation function to update the corresponding documentation section. ValidMind automatically recreates the relevant figures and tables, updating them in the online documentation.
 
 ValidMind is currently working on a version history function, which will allow users to see the history of changes made to the documentation.
 
 ## Can you accommodate Spark DataFrames?
 
-Our {{< var vm_framework >}} can extract dataset quality metrics on Pandas DataFrame, NumPy arrays, or Spark DataFrame instances using standard metrics provided by popular open-source frameworks such as scikit-learn, statsmodels, and more.
+Our {{< var validmind_developer >}} can extract dataset quality metrics on Pandas DataFrame, NumPy arrays, or Spark DataFrame instances using standard metrics provided by popular open-source frameworks such as scikit-learn, statsmodels, and more.
 
-Each test defines a mapping to the different supported dataset and/or model interfaces: when passing a Spark DataFrame, our {{< var vm_dev >}} will directly call native evaluation metrics provided by the SparkML API or custom ones built by the developer (such as via UDFs).
+Each test defines a mapping to the different supported dataset and/or model interfaces: when passing a Spark DataFrame, our {{< var developer >}} will directly call native evaluation metrics provided by the SparkML API or custom ones built by the developer (such as via UDFs).
 
 ## How does ValidMind handle end-user computing and spreadsheet models?
 

site-unused/qmd/get-started-closed-beta.qmd

@@ -11,7 +11,7 @@ _Thank you for joining ValidMind's closed beta! We hope that you will find our b
 
 Most of our large language model (LLM) testing and documentation generation features will be available for you to test during the closed beta. This includes both the ValidMind Model Documentation Automation and AI Risk Management platform. 
 
-Practically, this means you will interact with our {{< var vm_dev >}} through Jupyter Notebooks to run sample code. You will also log into our cloud-based {{< var vm_ui >}} to look at the output the {{< var vm_dev >}} generated as part of running the sample code. The Jupyter Notebooks we provide are meant to be self-documenting, meaning they include most everything you need to know to run them. 
+Practically, this means you will interact with our {{< var developer >}} through Jupyter Notebooks to run sample code. You will also log into our cloud-based {{< var platform >}} to look at the output the {{< var developer >}} generated as part of running the sample code. The Jupyter Notebooks we provide are meant to be self-documenting, meaning they include most everything you need to know to run them. 
 
 If you have never tried our products, you can also spend a few minutes reading [What do I use the ValidMind platform for?](get-started.qmd#what-do-i-use-the-validmind-platform-for). And for the beta specifically, these blog posts provide a bit more context:
 
@@ -50,11 +50,11 @@ A larger group of closed beta participants that will benefit from the improvemen
 Step-by-step instructions for testing: 
 
 <!--- TO DO Do we need the OW folks to follow this step? --->
-1. Get your credentials for the {{< var vm_ui >}} by signing up with ValidMind: [{{< var vm_url >}}]({{< var vm_url >}})
+1. Get your credentials for the {{< var platform >}} by signing up with ValidMind: [{{< var vm_url >}}]({{< var vm_url >}})
 
-   This is the login URL for our {{< var vm_ui >}} where you can look at the model inventory for the different models. 
+   This is the login URL for our {{< var platform >}} where you can look at the model inventory for the different models. 
 
-2. When you receive your access credentials, make sure you can log into the {{< var vm_ui >}}.
+2. When you receive your access credentials, make sure you can log into the {{< var platform >}}.
 
 3. Book a kick-off session with ValidMind by emailing <info@validmind.ai>.
 
@@ -70,15 +70,15 @@ Step-by-step instructions for testing:
 
 ### What to test
 
-We provide Jupyter Notebooks that include sample code you can run directly with the {{< var vm_framework >}}: 
+We provide Jupyter Notebooks that include sample code you can run directly with the {{< var validmind_developer >}}: 
 
 ::: {.callout title="What is 'Yes'?"}
 Throughout the early access for friends and family, we will update this table, so check back on a weekly basis.<br><br>Can't wait? Much of the sample code in the notebooks is already on JupyterHub, though it may not be as easily consumable.
 :::
 
 | Ready | Notebook | Model Inventory |
 |-----------|----------|-----------------|
-| Yes | **[quickstart_customer_churn_full_suite.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb)**<br>Useful if you have never tried ValidMind before. Walks you through the basics of our {{< var vm_dev >}} and the {{< var vm_ui >}}. | [Demo] Customer Churn Model Documentation — Full Suite
+| Yes | **[quickstart_customer_churn_full_suite.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/quickstart_customer_churn_full_suite.ipynb)**<br>Useful if you have never tried ValidMind before. Walks you through the basics of our {{< var developer >}} and the {{< var platform >}}. | [Demo] Customer Churn Model Documentation — Full Suite
 | Yes | **[nlp_and_llm/prompt_validation_demo.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/prompt_validation_demo.ipynb)**<br>Guides you through running and documenting prompt validation tests for a large language model (LLM) specialized in sentiment analysis for financial news. | [Demo] Foundation Model - Text Sentiment Analysis
 | Yes | **[nlp_and_llm/foundation_models_integration_demo](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/foundation_models_integration_demo.ipynb).ipynb**<br>Guides you through the process of documenting a large language model (LLM) specialized in sentiment analysis for financial news. | [Demo] Foundation Model - Text Sentiment Analysis
 | Yes | **[nlp_and_llm/foundation_models_summarization_demo.ipynb](https://jupyterhub.validmind.ai/hub/user-redirect/lab/tree/nlp_and_llm/foundation_models_summarization_demo.ipynb)**<br>Guides you through the process of documenting a large language model (LLM) specialized in summarization of financial news. | [Demo] Foundation Model - Text Summarization
@@ -89,15 +89,15 @@ Throughout the early access for friends and family, we will update this table, s
 
 ### Where to test
 
-#### {{< var vm_framework >}}
+#### {{< var validmind_developer >}}
 
 Jupyter Notebooks (code samples) are available in: [JupyterHub](https://jupyterhub.validmind.ai) 
 
 Alternatively, you can download the notebooks locally and try them out in your own developer environment.
 
-#### {{< var vm_platform >}}
+#### {{< var validmind_platform >}}
 
-Jupyter Notebooks will often tell you where to look specifically after you run the sample code, but the login for the {{< var vm_ui >}} is always the same: [{{< var vm_url >}}]({{< var vm_url >}})
+Jupyter Notebooks will often tell you where to look specifically after you run the sample code, but the login for the {{< var platform >}} is always the same: [{{< var vm_url >}}]({{< var vm_url >}})
 
 ## Provide feedback
 

site-unused/qmd/index-old.qmd

@@ -81,7 +81,7 @@ html:
                     <div class="card" style="border-style: none;background: transparent;"><img class="card-img-top w-100 d-block" style="border-radius: 8px;" src="assets/img/validmind-flowchart.png">
                         <div class="card-body" style="padding-top: 12px;padding-bottom: 12px;">
                             <h4 class="card-title">Model Developers</h4>
-                            <p class="card-text" style="margin-bottom: 0;">Automate your model documentation and testing tasks with the {{< var vm_framework >}}.</p><a class="text-nowrap" type="button" style="padding: 0;color: var(--bs-pink);background: transparent;border-radius: 4px;margin-top: 24px;font-family: 'Inter';font-style: normal;font-weight: 700;font-size: 14px;line-height: 100%;border: 1px none #475569;text-decoration: underline;" href="guide/get-started-developer-framework.html">Get started</a>
+                            <p class="card-text" style="margin-bottom: 0;">Automate your model documentation and testing tasks with the {{< var validmind_developer >}}.</p><a class="text-nowrap" type="button" style="padding: 0;color: var(--bs-pink);background: transparent;border-radius: 4px;margin-top: 24px;font-family: 'Inter';font-style: normal;font-weight: 700;font-size: 14px;line-height: 100%;border: 1px none #475569;text-decoration: underline;" href="guide/get-started-developer-framework.html">Get started</a>
                         </div>
                     </div>
                     <div class="w-100"></div>

site-unused/qmd/login.qmd

@@ -1,29 +1,29 @@
 ---
-title: "Log into the {{< var vm_platform >}}"
+title: "Log into the {{< var validmind_platform >}}"
 date: last-modified
 ---
 
-Log into our cloud-hosted {{< var vm_ui >}} to collaborate with others.
+Log into our cloud-hosted {{< var platform >}} to collaborate with others.
 
 ## Prerequisites
 
-- A valid email address registered with the {{< var vm_platform >}}.
+- A valid email address registered with the {{< var validmind_platform >}}.
 - Your password associated with the registered email address.
 
 ### Steps
 
 ::: {.column-margin}
 ::: {.callout}
 ## Using a company VPC?
-Log in through AWS PrivateLink: [{{< var vm_ui_privatelink >}}]({{< var vm_ui_privatelink >}})
+Log in through AWS PrivateLink: [{{< var vm_privatelink >}}]({{< var vm_privatelink >}})
 :::
 :::
 
-1. In a web browser, go to [{{< var vm_ui >}}]({{< var vm_url >}}).
+1. In a web browser, go to [{{< var platform >}}]({{< var vm_url >}}).
 2. Click **Log In** and enter your email address and password.
 3. Click **Continue**.
 
-After successful login, you are redirected to the main dashboard of the {{< var vm_platform >}} where you can start exploring the features of the {{< var vm_ui >}}.
+After successful login, you are redirected to the main dashboard of the {{< var validmind_platform >}} where you can start exploring the features of the {{< var platform >}}.
 
 <!---
 ## What's next

site-unused/qmd/manage-users-and-roles.qmd

@@ -2,7 +2,7 @@
 title: "Manage users and roles"
 ---
 
-User management involves controlling and organizing user accounts within the {{< var vm_platform >}}. It encompasses tasks like user creation, authentication, authorization, and access control. Effective user management is essential for maintaining security and operational efficiency. 
+User management involves controlling and organizing user accounts within the {{< var validmind_platform >}}. It encompasses tasks like user creation, authentication, authorization, and access control. Effective user management is essential for maintaining security and operational efficiency. 
 
 ## Prerequisites
 

site-unused/qmd/mermaid-diagrams-dev-framework.qmd

@@ -23,7 +23,7 @@ graph TD
     H --> E
 ```
 
-### In {{< var vm_platform >}}
+### In {{< var validmind_platform >}}
 
 ```{mermaid}
 graph TB

site-unused/qmd/review-documentation.qmd

@@ -3,17 +3,17 @@ title: "Review and comment on documentation"
 date: last-modified
 ---
 
-Learn how to use the {{< var vm_platform >}} editor to review, and comment on model documentation. This topic is relevant for:
+Learn how to use the {{< var validmind_platform >}} editor to review, and comment on model documentation. This topic is relevant for:
 
-* Model developers who want to review their model documentation in the {{< var vm_ui >}}
+* Model developers who want to review their model documentation in the {{< var platform >}}
 * Model developers who want to post a comment or to respond to a comment on model documentation
 
 ## Prerequisites
 
 * The model you are documenting is registered in the model inventory
 * Model documentation has already been created for this
-* A model developer has started generating documentation, either using the {{< var vm_dev >}} or via the online UI editor
-* You are logged into the {{< var vm_platform >}}
+* A model developer has started generating documentation, either using the {{< var developer >}} or via the online UI editor
+* You are logged into the {{< var validmind_platform >}}
 
 ## View model documentation