Skip to content

Add basic Nutshell example for experimentation #256

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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions site/_log-in.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
##### {{< fa circle-exclamation >}} Before you begin
Make sure you are [logged in to the ValidMind Platform UI](/link-to-login-page.qmd).
5 changes: 4 additions & 1 deletion site/guide/configuration/managing-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ listing:
contents:
- set-up-your-organization.qmd
- configure-aws-privatelink.qmd
filters:
- nutshell
---

Access to the {{< var validmind_platform >}} is associated with an organization, which encompasses all your users, groups, and business units. As a user, you can belong to multiple organizations.
Expand All @@ -24,7 +26,8 @@ To perform these steps, you must have access to the {{< var vm_login >}}.
You will only see the option to switch between organizations if you belong to more than one organization.
:::

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

1. [:Log in to ValidMind](/nutshell/login.qmd#x-step-1).

2. Click **{{< fa gear >}} Settings**.

Expand Down
12 changes: 6 additions & 6 deletions site/guide/model-inventory/register-models-in-inventory.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ To be able to document models using ValidMind's model documentation and validati
- You are the model owner.
- You hold the `Developer` role.[^1]

## Steps
{{< include /_log-in.qmd >}}

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

2. Click **Model Inventory** in the left sidebar.
1. Click **Model Inventory** in the left sidebar.
<!--- **Need screenshot** --->

3. Click **Register new model**.
2. Click **Register new model**.

4. Fill in the required information on the registration form:
3. Fill in the required information on the registration form:

- Provide a model name
- Select the relevant business unit
Expand All @@ -29,7 +29,7 @@ To be able to document models using ValidMind's model documentation and validati
- Select the preliminary risk tier for the model
- If the model is a vendor model, toggle **Is Vendor Model**[^2] and provide the vendor name.

5. Click **Register new model** to create a new entry in the model inventory.
4. Click **Register new model** to create a new entry in the model inventory.

You can now access the model details from the **Model Inventory** page.

Expand Down
12 changes: 12 additions & 0 deletions site/nutshell/login.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## :x step-1

<!-- Use `## :x header` to include an invisible section that can be linked to via nutshell -->

In a web browser, open one of the the URLs for the {{< var validmind_platform >}}:

| Name    | Provider    | Region          | URL |
|---|---|---|---|
| US1 | AWS | us-east-1 | [{{< var vm_url_us1 >}}]({{< var vm_url_us1 >}}) |
| CA1 | AWS | ca-west-1 | [{{< var vm_url_ca1 >}}]({{< var vm_url_ca1 >}}) |

If unsure which URL to use, we recommend US1 or consult your organization for data stewardship requirements. For instance, if your data must stay in Canada, use CA1.
34 changes: 33 additions & 1 deletion site/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,38 @@ pre, pre.python, pre.bash, pre.yaml {
text-underline-offset: 10px;
}

.nutshell-expandable {
color: #DE257E;
text-decoration: none;
/* border-bottom: dotted 1.5px; */
position: relative;
transition: opacity 0.1s ease-in-out;
opacity: 1;
}

.nutshell-expandable:hover {
color: #DE257E;
text-decoration: none;
}

.nutshell-bubble {
box-shadow: 2px 2px 4px rgba(0, 0, 0, 0.2);
border-radius: 5px;
}

.nutshell-bubble-from {
opacity: 0;
}

.nutshell-bubble-overflow-embed-button img {
width: 0em;
height: 0em;
}

/* .nutshell-ball-up, .nutshell-ball-down {
visibility: hidden;
} */

/* section#footnotes {
display: none !important;
}
Expand All @@ -243,4 +275,4 @@ pre, pre.python, pre.bash, pre.yaml {
.column-margin {
display: none !important;
}
} */
} */