Instructions for upgrading ValidMind (#490)

* Updated version.validmind variable

* Edited _how-to-upgrade.qmd

* Added Upgrade ValidMind instructions

* Adjusted Troubleshooting page

* Final? tweaks

* Update site/releases/_how-to-upgrade.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/developer/model-documentation/install-and-initialize-client-library.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/developer/model-documentation/install-and-initialize-client-library.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

Author: validbeck

site/_variables.yml

@@ -66,7 +66,7 @@ gcp:
 
 version:
   python: "≧3.8 and <3.11"
-  validmind: v2.0.7
+  validmind: v2.5.19
 
 # OTHER
 

site/developer/model-documentation/install-and-initialize-client-library.qmd

@@ -4,6 +4,8 @@ date: last-modified
 aliases:
   - install-and-initialize-validmind.html
   - ../../guide/install-and-initialize-developer-framework.html
+filters:
+  - tachyons
 ---
 
 ValidMind generates a unique _code snippet_ for each registered model to connect with your developer environment. You initialize the client library with this code snippet, ensuring that your documentation and tests are uploaded to the correct model. 
@@ -31,7 +33,9 @@ The {{< var vm.developer >}} also requires access to the data sources where data
 
 :::
 
-## Locate the {{< var vm.developer >}} integration instructions
+## Install ValidMind
+
+### Locate the {{< var vm.developer >}} integration instructions
 
 For existing models, this information can be found in the {{< var validmind.platform >}}:
 
@@ -43,15 +47,15 @@ For existing models, this information can be found in the {{< var validmind.plat
 
 4. Locate the code snippet and click **{{< fa regular copy >}} Copy snippet to clipboard**. 
 
-## Install the client library
+### Install the client library
 
 To install the client library:
 
 ```python
 %pip install validmind
 ```
 
-## Initialize the client library
+### Initialize the client library
 
 To initialize the client library, paste the code snippet with the client integration details directly into your development source code, replacing this example with your own:
 
@@ -72,6 +76,38 @@ To also enable monitoring, add `monitoring=True` to the `vm.init` method in your
 
 After you have pasted the code snippet into your development source code and run your code, the Python client library will connect and register with ValidMind. You can now use the {{< var vm.developer >}} to document and test your models, and to upload model documentation and test results to the {{< var vm.platform >}}.
 
+## Upgrade ValidMind
+
+After installing ValidMind,[^5] you'll want to periodically make sure you are on the latest version to access any new features and other enhancements: 
+
+1. In your Jupyter Notebook or developer environment, retrieve the information for the currently installed version of ValidMind:
+
+    ```python
+    %pip show validmind
+    ```
+
+::: {.column-margin}
+**Example output:**
+```bash
+Name: validmind
+Version: 2.5.15
+...
+```
+:::
+
+2. If the version returned is lower than the version indicated in our production open-source code,[^6] run the following command:
+
+    ```python
+    %pip install --upgrade validmind
+    ```
+
+::: {.column-margin}
+::: {.callout title="Current version:"}
+{{< var version.validmind >}}
+:::
+:::
+
+
 <!-- FOOTNOTES -->
 
 [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
@@ -80,4 +116,8 @@ After you have pasted the code snippet into your development source code and run
 
 [^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
 
-[^4]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
+[^4]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
+
+[^5]: [Install ValidMind](#install-validmind)
+
+[^6]: **GitHub:** [validmind/developer-framework/validmind/&lowbar;&lowbar;version&lowbar;&lowbar;.py](https://github.com/validmind/developer-framework/blob/prod/validmind/__version__.py)

site/releases/_how-to-upgrade.qmd

@@ -11,16 +11,23 @@ To access the latest version of the {{< var validmind.platform >}},^[[Log in to
 
 #### {{< var validmind.developer >}}
 
-To upgrade the {{< var validmind.developer >}}:^[[Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)]
+To upgrade to the latest version of the {{< var validmind.developer >}}:^[[Get started with the {{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)]
 
-- [Using JupyterHub](/get-started/developer/try-with-jupyterhub.qmd): Hard refresh your browser tab and re-run the `%pip install --upgrade validmind` cell.
+1. In your Jupyter Notebook:
+
+    - **Using JupyterHub:**^[[Try it with JupyterHub](/get-started/developer/try-with-jupyterhub.qmd)] Hard refresh your browser tab.
+    - **In your own developer environment**:^[[Try it in your own developer environment](/get-started/developer/try-in-your-own-environment.html)] Restart your notebook.
+
+2. Locate the `%pip install -q validmind` cell and replace the contents with:
 
-- [In your own developer environment](/developer/model-documentation/install-and-initialize-client-library.qmd): Restart your notebook and re-run:
-    
     ```python
-    %pip install validmind
+    %pip install --upgrade validmind
     ```
 
-You may need to restart your kernel after re-running the installation package for changes to be applied.
+3. Run the edited code cell.
+
+::: {.callout-important}
+You may need to restart your kernel after running the upgrade package for changes to be applied.
+:::
 
 :::

site/support/support.qmd

@@ -3,6 +3,20 @@ title: "Support"
 date: last-modified
 aliases:
   - ../guide/support.html
+filters:
+  - tachyons
+listing:
+  id: get-help
+  type: grid
+  sort: false
+  grid-columns: 2
+  # image-height: 100%
+  contents:
+    - path: troubleshooting.qmd
+    - path: mailto:support@validmind.com
+      title: "{{< fa envelope-circle-check >}} support@validmind.com"
+      description: "Don't see what you're looking for? Send us an email to get help from a human."
+  fields: [title, description]
 ---
 
 Our support team can provide you with quick and easy access to the resources you need to troubleshoot technical issues and help you get the most out of the {{< var validmind.product >}}.
@@ -29,7 +43,5 @@ Additional troubleshooting content might be available in the [Help Center](https
 
 ## Get help 
 
-::: {.callout title="Don't see what you are looking for? "}
-Email [support@validmind.com](mailto:support@validmind.com) to get help from a human.
-
+:::{#get-help}
 :::

site/support/troubleshooting.qmd

@@ -1,44 +1,81 @@
 ---
 title: "Troubleshooting"
 date: last-modified
+toc-depth: 2
 aliases:
   - ../guide/troubleshooting.html
+listing:
+  id: more
+  type: grid
+  sort: false
+  grid-columns: 2
+  # image-height: 100%
+  contents:
+    - path: ../faq/faq.qmd
+      title: "FAQ"
+      description: "Browse through common questions."
+    - path: support.qmd
+      title: "Contact Support"
+      description: "Get more help with troubleshooting technical issues."
+  fields: [title, description]
 ---
 
-Learn how to resolve commonly encountered issues with the {{< var vm.developer >}}.
+Learn how to resolve commonly encountered issues with the {{< var validmind.product >}}.
+
+## Cannot access expected features
+
+### Issue
+You cannot access functionality described in our user guides or recent releases.
+
+### Fix
+Make sure you are running most recent versions of ValidMind,[^1] and have the proper permissions assigned.[^2]
 
 ## Cannot install the {{< var validmind.developer >}}
 
-#### Issue
+### Issue
 You cannot run `pip install validmind` or `import validmind as vm` in the {{< var validmind.developer >}} notebooks.
 
-#### Fix
-Make sure you are installing the latest version of the {{< var vm.developer >}} by running this command:
+### Fix
+Make sure you are installing the latest version of the {{< var vm.developer >}}[^3] by running this command:
+
+  ```python
+  %pip install --upgrade validmind
+  ```
 
-```python
-%pip install --upgrade validmind
-```
 
 ## Cannot initialize ValidMind client library
 
-#### Issue
+### Issue
 When you run `vm.init()`, you encounter an error message like this: 
 
-```bash
-MissingAPICredentialsError: API key and secret must be provided either as environment variables or as arguments to init.
-```
+  ```bash
+  MissingAPICredentialsError: API key and secret must be provided either as environment variables or as arguments to init.
+  ```
 
 or
 
-```bash
-InvalidProjectError: Model could not be found
-```
+  ```bash
+  InvalidProjectError: Model could not be found
+  ```
 
-#### Fix
+### Fix
 Make sure that you are using the correct initialization credentials for the model you are trying to connect to. 
 
 Follow the steps in [Install and initialize the client library](/developer/model-documentation/install-and-initialize-client-library.qmd) for detailed instructions on how to integrate the {{< var vm.developer >}} and upload to the {{< var vm.platform >}}.
 
+<span id="how-to-upgrade"><span>
+{{< include /releases/_how-to-upgrade.qmd >}}
+
 ## Additional resources
 
-Check out our [FAQ](/faq/faq.qmd) page to browse through common questions, or [contact our support team](support.qmd) for more help troubleshooting technical issues.
+:::{#more}
+:::
+
+
+<!-- FOOTNOTES -->
+
+[^1]: [{{< fa arrow-up-from-bracket >}} How to upgrade](#how-to-upgrade)
+
+[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
+
+[^3]: [Upgrade ValidMind](/developer/model-documentation/install-and-initialize-client-library.qmd#upgrade-validmind)