Skip to content

Merge main into staging #585

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 2 commits into from
Dec 12, 2024
Merged
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
113 changes: 97 additions & 16 deletions site/guide/configuration/customize-your-dashboard.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: "Customize your dashboard"
date: last-modified
---

Customize what you see on your {{< var vm.product >}} dashboard when you first log in. <!-- Rearrange the position of widgets, and add your own widgets from reporting for quick access. -->

<!-- Ability to add report widgets has been temporarily removed as of the launch of the new analytics page -->
Customize what you see on the {{< var validmind.platform >}} when you first log in with dashboards and widgets, enabling you to review and access information at a glance.

:::{.callout}
Changes are automatically saved to your account and do not affect other users.
Expand All @@ -19,42 +17,125 @@ Changes are automatically saved to your account and do not affect other users.

:::

## Arrange widgets
## Manage dashboards

Dashboards allow you to use widgets to quickly review and access information by displaying widgets.[^1]

### Add dashboards

1. In the left sidebar, click **{{< fa home >}} Dashboard**.

2. Click **{{< fa plus>}} Add Dashboard**.

3. On the Add New Dasboard modal that appears, enter the:

- **[dashboard name]{.smallcaps}**
- **[description]{.smallcaps}** (optional)

4. Click **Add New Dashboard** to create your dashboard.

### Edit or remove dashboards

::: {.callout-important}
Deletion of dashboards is permanent.

:::

1. In the left sidebar, click **{{< fa home >}} Dashboard**.

2. Click on the tab for the dashboard you would like to edit or remove.

3. Click on **{{< fa ellipsis-vertical >}}** to edit the name and description of your dashboard or to delete a dashboard:

- To edit a dashboard, select **Edit Dashboard Details**. Make your edits then click **Save Changes** to apply your adjustments.
- To remove a dashboard, select [**{{< fa trash-can >}} Delete Dashboard**]{.red}. Once you confirm, your dashboard will be deleted.

## Manage widgets

Widgets display information at a glance on your dashboards.[^2]

#### Widget types

Model Inventory View
: Retrieves a saved model inventory view.[^3]

Model Findings View
: Retrieves a saved findings view.[^4]

Analytics Visualization
: Retrieves an analytics visualization.[^5]

Other
: Retrieve a list of the latest model findings[^6] or recent activity.[^7]

### Arrange widgets

1. On the {{< fa home >}} Dashboard, hover over the title of a widget until the **{{< fa hand>}}** appears.

2. Click and drag to position your widget as desired.

To resize a widget, hover over the bottom-right corner of a widget until the **{{< fa hand>}}** appears, then adjust the dimensions to your liking.

<!-- ## Add report widgets
### Add widgets

1. In the left sidebar, click **{{< fa home >}} Dashboard**.

2. Click on the tab for the dashboard you would like to add a widget to.

3. Click **{{< fa plus >}} Add Widget**.

Along with the default {{< fa triangle-exclamation >}} Model Findings and Recent Activity widgets, report widgets from Analytics[^1] can be added to your dashboard:
4. Select the type of widget you'd like to add:[^8]

1. In the left sidebar, click **{{< fa square-poll-vertical >}} Analytics**.
- **Model Inventory View**
- **Model Findings View**
- **Analytics Visualization**
- **Other**

2. Hover over the title of the widget you'd like to place on the {{< fa home >}} Dashboard until the **{{< fa ellipsis-vertical>}}** appears, then click on it.
5. On the modal that appears, configure the information retrieved by the widget:

3. After you select **{{< fa plus>}} Add to Dashboard**, the widget will appear on your personal view of the dashboard.
- **Model Inventory View** — Select a **[view name]{.smallcaps}** then cick **Add Model Inventory View**.
- **Model Findings View** — Select a **[view name]{.smallcaps}** then cick **Add Model Findings View**.
- **Analytics Visualization** — Select an **[analytics page]{.smallcaps}** and a **[visualization]{.smallcaps}** then click **Add Visualization**.
- **Other** — Select one of the **[widgets]{.smallcaps}** then click **Add Widget**.

You can then rearrange the position of the widget to your liking.[^2]
6. Confirm that your widget appears as expected.

## Remove report widgets
You can also rearrange the position of the widget to your liking.[^9]

To remove a report widget you added:
### Remove widgets

::: {.callout-important title="Removal of widgets is permanent."}
Removing a widget from a dashboard will not delete the linked view or analytics visualization.

:::

1. In the left sidebar, click **{{< fa home >}} Dashboard**.

2. Hover over the title of a widget you'd like to remove until the **{{< fa ellipsis-vertical>}}** appears, then click on it.
2. Click on the tab for the dashboard you would like to remove widgets from.

3. Hover over the widget you would like to remove until the **{{< fa ellipsis-vertical >}}** appears and then click on it.

4. Select [**{{< fa trash-can >}} Remove**]{.red}.

3. After you select **{{< fa trash-can>}} Remove from Dashboard**, the widget will be removed from your personal view of the dashboard. -->
5. Once you confirm, your widget will be removed from your dashboard.


<!-- FOOTNOTES -->

<!-- [^1]: [Working with analytics](/guide/reporting/working-with-analytics.qmd)
[^1]: [Manage widgets](#manage-widgets)

[^2]: [Manage dashboards](#manage-dashboards)

[^3]: [Customize model inventory layout](/guide/model-inventory/customize-model-inventory-layout.qmd#manage-custom-inventory-views)

[^4]: [View and filter model findings](/guide/model-validation/view-filter-model-findings.qmd#customize-model-findings-layout)

[^5]: [Working with analytics](/guide/reporting/working-with-analytics.qmd)

[^2]: [Rerrange widgets](#rearrange-widgets) -->
[^6]: [Working with model findings](/guide/model-validation/working-with-model-findings.qmd)

[^7]: [View model activity](/guide/model-inventory/view-model-activity.qmd)

[^8]: [Widget types](#widget-types)

[^9]: [Arrange widgets](#arrange-widgets)
Loading