Skip to content

Docs site audit part 2 - inline link cleanup #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d171ddd
Added a vm_login variable for instructions to reference
validbeck Jun 13, 2024
316f13d
Changed #1 login to the variable
validbeck Jun 13, 2024
92424c3
Adjusted the hacky CSS on customize-documentation-templates.qmd
validbeck Jun 13, 2024
7978a87
Adjusted some guides that were missing the #1 login step
validbeck Jun 13, 2024
b60cdbe
Final pass of the login variable
validbeck Jun 18, 2024
a928ba8
Pulled latest from main so I could review those for login variable
validbeck Jun 18, 2024
af2fc5f
Manually fixed merge conflicts & login variables in includes files
validbeck Jun 18, 2024
e420084
1st pass of extraneous links within instructions
validbeck Jun 18, 2024
6dfd7ef
2nd pass of extraneous instruction links & quick style tweaks
validbeck Jun 19, 2024
e7d5724
Last pass extraneous links/margin learn mores until roles/permissions…
validbeck Jun 19, 2024
eb54565
Reviewed bolding of links & retooled About landing page
validbeck Jun 19, 2024
bda4e32
Pulled in latest PR#221 from main and resolved those merge conflicts
validbeck Jun 20, 2024
2d7fc58
Penultimate-pass of margin links
validbeck Jun 20, 2024
ab3f292
Added margin content to style guide
validbeck Jun 20, 2024
c55094a
Quick adjust to collaborate with others
validbeck Jun 20, 2024
9499c58
Quick edit to the summaries for automation & risk management
validbeck Jun 20, 2024
c8220fb
Pulled in latest PR#219 from main and resolved any merge conflicts
validbeck Jun 20, 2024
92e289e
Removed the bullet points from margin lists
validbeck Jun 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site-unused/before-you-begin.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To follow the QuickStart, you need access to ONE of the following:
- [Google Colaboratory (Colab)](quickstart-try-developer-framework-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

Expand Down
2 changes: 1 addition & 1 deletion site-unused/create-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Upload documentation and test results for a specific model, to review and valida

## Steps

1. [Log in to the {{< var vm_platform >}}]({{< var vm_url >}}).
1. Log in to the {{< var vm_login >}}.

2. On the **Documentation Projects** page, click **Create new project**.

Expand Down
10 changes: 5 additions & 5 deletions site-unused/get-started-closed-beta.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

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:

Expand Down Expand Up @@ -58,7 +58,7 @@ Step-by-step instructions for testing:

3. Book a kick-off session with ValidMind by emailing <info@validmind.ai>.

4. Try the closed beta Jupyter notebooks for LLM functionality:
4. Try the closed beta Jupyter Notebooks for LLM functionality:

- [What to test](#what-to-test)
- [Where to test](#where-to-test)
Expand All @@ -70,7 +70,7 @@ 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 vm_framework >}}:

::: {.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.
Expand All @@ -91,13 +91,13 @@ Throughout the early access for friends and family, we will update this table, s

#### {{< var vm_framework >}}

Jupyter notebooks (code samples) are available in: [JupyterHub](https://jupyterhub.validmind.ai)
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 >}}

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 vm_ui >}} is always the same: [{{< var vm_url >}}]({{< var vm_url >}})

## Provide feedback

Expand Down
43 changes: 43 additions & 0 deletions site-unused/manage-roles-and-permissions.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "Manage roles & permissions"
---

These steps guide you through the process of configuring and overseeing roles and permissions in the {{< var vm_platform >}}. By carefully defining what users can and cannot do, you can ensure that the right individuals have the appropriate level of access to resources and can perform the correct actions.

## Prerequisites

To perform these steps, you must be a group administrator or a superuser.

## Add roles

To add a new role:

1. Log in to the {{< var vm_login >}}.

1. Click **Settings**.

{{< include _manage-roles-and-permissions-roles.qmd >}}

## Manage permissions

To manage the permissions for existing roles:

1. Log in to the {{< var vm_login >}}.

2. Click **Settings**.

{{< include _manage-roles-and-permissions-permissions.qmd >}}

::: {.callout-important}
Be careful when modifying permissions to ensure they align with the role's intended responsibilities and access requirements.
:::

<!---
## Troubleshooting

[Include any common issues or errors that may arise during the task and how to resolve them.]

## What's next

[Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
--->
2 changes: 1 addition & 1 deletion site-unused/review-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Learn how to use the {{< var vm_platform >}} editor to review, and comment on mo

2. Enter your comment and click **Submit**.

3. You can now view the comment by highlighting the corresponding portion of text or by clicking the **Comments** tab in the **ValidMind Insights** right sidebar.
3. You can now view the comment by highlighting the corresponding portion of text or by clicking the **Comments** tab in the **ValidMind Insights** right sidebar.

<!---
## Troubleshooting
Expand Down
15 changes: 7 additions & 8 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,13 @@ website:

- title: "About"
contents:
- text: "About"
file: about/overview.qmd
- text: "---"
- text: "FEATURES"
- text: "Automated testing & documentation"
file: about/overview-model-documentation.qmd
- text: "Model risk governance management"
file: about/overview-model-risk-management.qmd
- file: about/overview.qmd
text: "About"
contents:
- text: "Automated testing & documentation"
file: about/overview-model-documentation.qmd
- text: "Model risk governance management"
file: about/overview-model-risk-management.qmd
- about/glossary/glossary.qmd

- text: "---"
Expand Down
23 changes: 12 additions & 11 deletions site/_site/about/data-privacy-policy.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,28 +224,29 @@
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview.html" class="sidebar-item-text sidebar-link">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../about/overview.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">About</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FEATURES</span>
</li>
<li class="sidebar-item">
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 ">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview-model-documentation.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Automated testing &amp; documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview-model-risk-management.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Model risk governance management</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/glossary/glossary.html" class="sidebar-item-text sidebar-link">
Expand Down
29 changes: 15 additions & 14 deletions site/_site/about/glossary/glossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,28 +223,29 @@
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../about/overview.html" class="sidebar-item-text sidebar-link">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../../about/overview.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">About</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FEATURES</span>
</li>
<li class="sidebar-item">
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 ">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../about/overview-model-documentation.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Automated testing &amp; documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../about/overview-model-risk-management.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Model risk governance management</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../about/glossary/glossary.html" class="sidebar-item-text sidebar-link active">
Expand Down Expand Up @@ -523,14 +524,14 @@ <h4 class="anchored" data-anchor-id="models">Models</h4>
</dl>
<p>Within the realm of model risk management, this documentation serves to ensure transparency, adherence to regulatory requirements, and a clear understanding of potential risks associated with the model’s application.</p>
<dl>
<dt>model inventory</dt>
<dt>model inventory<sup>1</sup></dt>
<dd>
A systematic and organized record of all quantitative and qualitative models used within an organization. This inventory facilitates oversight, tracking, and assessment by listing each model’s purpose, characteristics, owners, validation status, and associated risks.
</dd>
</dl>

<div class="no-row-height column-margin column-container"><div class="">
<p><strong>Refer also to:</strong> <a href="../../about/glossary/glossary.html#platform-model-inventory">ValidMind model inventory</a></p>
<p><strong><sup>1</sup>Refer also to:</strong> <a href="../../about/glossary/glossary.html#platform-model-inventory">ValidMind model inventory</a></p>
</div></div><dl>
<dt>model lifecycle</dt>
<dd>
Expand Down Expand Up @@ -766,7 +767,7 @@ <h2 class="anchored" data-anchor-id="developer-tools">Developer tools</h2>
Metrics are a subset of tests that do not have thresholds. Custom metrics are functions that you define to evaluate your model or dataset. These functions can be registered with ValidMind to be used in the platform.
</dd>
</dl>
<p>In the context of ValidMind’s Jupyter notebooks, metrics and tests can be thought of as interchangeable concepts.</p>
<p>In the context of ValidMind’s Jupyter Notebooks, metrics and tests can be thought of as interchangeable concepts.</p>
<dl>
<dt>GitHub</dt>
<dd>
Expand Down
Binary file added site/_site/about/inline-links_incorrect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 12 additions & 11 deletions site/_site/about/license-agreement.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,28 +223,29 @@
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview.html" class="sidebar-item-text sidebar-link">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a href="../about/overview.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">About</span></a>
</div>
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FEATURES</span>
</li>
<li class="sidebar-item">
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="" class="collapse list-unstyled sidebar-section depth1 ">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview-model-documentation.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Automated testing &amp; documentation</span></a>
</div>
</li>
<li class="sidebar-item">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/overview-model-risk-management.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Model risk governance management</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../about/glossary/glossary.html" class="sidebar-item-text sidebar-link">
Expand Down
Binary file added site/_site/about/margin-content_correct.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading