From c0374bff3ad3f4a0e7c44a988484bcb357a623be Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Wed, 4 Sep 2024 13:14:09 -0700
Subject: [PATCH 01/10] Draft of new release notes
---
site/_quarto.yml | 1 +
.../working-with-model-workflows.qmd | 17 ++++
site/releases/2024-sep-09/release-notes.qmd | 97 +++++++++++++++++++
3 files changed, 115 insertions(+)
create mode 100644 site/releases/2024-sep-09/release-notes.qmd
diff --git a/site/_quarto.yml b/site/_quarto.yml
index 1731f9a512..d09c6f1f0e 100644
--- a/site/_quarto.yml
+++ b/site/_quarto.yml
@@ -106,6 +106,7 @@ website:
- text: "---"
- text: "RELEASES"
# MAKE-RELEASE-NOTES-EMBED-MARKER
+ - releases/2024-sep-09/release-notes.qmd
- releases/2024-aug-13/release-notes.qmd
- releases/2024-jul-22/release-notes.qmd
- releases/2024-jun-10/release-notes.qmd
diff --git a/site/guide/model-workflows/working-with-model-workflows.qmd b/site/guide/model-workflows/working-with-model-workflows.qmd
index 9860ce1a57..6331b19b36 100644
--- a/site/guide/model-workflows/working-with-model-workflows.qmd
+++ b/site/guide/model-workflows/working-with-model-workflows.qmd
@@ -81,6 +81,21 @@ To transition the workflow status of a model's documentation:
- Click **{{< fa arrow-right >}}** to open up the transition panel for your selected action. This arrow will be followed by the action name.
- Enter your **Notes** then click **Submit**. -->
+### Reset your model workflow
+
+If you need to reset your model's workflow to the beginning:
+
+1. In the left sidebar, click **Model Inventory**.
+
+2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^5]
+
+3. Click on **[model status]{.smallcaps}**.
+
+4. Select **Reset Workflow**.
+
+ After you confirm, that model's workflow will be returned to its initial state.
+
+
## What's next
:::{#model-workflows-listing}
@@ -97,3 +112,5 @@ To transition the workflow status of a model's documentation:
[^3]: [Working with model workflows](set-up-model-workflows.qmd)
[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
+
+[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
diff --git a/site/releases/2024-sep-09/release-notes.qmd b/site/releases/2024-sep-09/release-notes.qmd
new file mode 100644
index 0000000000..7c8280bd9c
--- /dev/null
+++ b/site/releases/2024-sep-09/release-notes.qmd
@@ -0,0 +1,97 @@
+---
+title: "September 9, 2024"
+---
+
+## Release highlights
+
+
+
+### Manage validation guidelines
+
+Added a new page in settings to manage risk areas and validation guidelines.
+
+
+
+Generated PR summary:
+
+This update brings various enhancements to the management of Risk Areas and Validation Guidelines. You will find a new `RiskAreas` page in the settings section where you can manage Risk Areas and their associated Validation Guidelines. New components such as `RiskAreaAccordionItem`, `GuidelineItem`, `UpdateGuidelineModal`, `UpdateRiskArea`, `DeleteRiskAreaModal`, and `DeleteGuidelineModal` support these functionalities.
+
+The API now includes methods for creating, updating, deleting, and fetching dependencies for Risk Areas and Guidelines, which are integrated into the actions object. In terms of navigation, a new route for the Risk Areas page is added to `src/App.tsx`. The Settings Sidebar and main Settings pages also provide links to this new page.
+
+Model updates include new types in guideline.ts and risk_area.ts files to support the enhanced API methods and data structures. Additionally, role.ts is updated with new permission actions related to guidelines.
+
+On the user interface side, you will notice an improved GuidelineItem component that better handles display and management tasks. New modals have been introduced for creating, updating, and deleting Risk Areas and Guidelines with appropriate validation.
+
+Lastly, note that the RiskAreasPanel has been removed from the Organization page as its function is now managed separately. There are also minor UI tweaks for an improved user experience.
+
+
+### Reset your model workflow
+
+Reset workflow
+
+You can now perform the `reset_workflow` action on an inventory model by clicking on the model status as a customer admin.
+
+
+
+
+Generated PR summary:
+
+This release introduces several significant updates:
+
+A new reset workflow functionality is now available. You can reset workflows using the new `ResetWorkflow` API method, which sends a PATCH request to the specified endpoint. This method is easily accessible through the actions object and includes a new event renderer for displaying reset workflow events in the activity feed. A confirmation modal has been added to verify the reset action before proceeding, and once confirmed, the page reloads to reflect the changes.
+
+Enhancements have been made to the `EditableField` component. It now supports optional `onSave` and `onCancel` callbacks, allowing for more customizable interactions. Additionally, you can now set a custom label for the save button through the new `saveButtonLabel` prop and display extra information using the `moreInfoPopoverProps` prop with the `MoreInfoPopOver` component. The sub-component `FieldTitle` now conditionally renders tooltips or custom elements based on an override property. These enhancements are integrated into managing model status on the InventoryModelOverview page.
+
+General improvements include exporting the `MoreInfoPopOver` component for reuse across different components and minor refactoring efforts aimed at improving code readability and maintainability throughout various parts of the application.
+
+
+
+## Enhancements
+
+### Model inventory fields
+
+Custom fields have been renamed to model inventory fields
+
+Generated PR summary:
+
+This update changes all instances of 'Custom Fields' to 'Model Inventory Fields' throughout the codebase. Several components, hooks, and pages have been edited for consistency in naming, including success and error messages, modal headers, helper texts, button labels, popover headers, sidebar labels, and toast messages. The functional behavior of the application remains unchanged; only the terminology displayed to you has been modified. Affected files include key components such as `CustomFieldModal`, `ModelInventoryTableColumnsPicker`, `CustomFieldRenderer`, and several settings-related pages and hooks. Additionally, redundant import statements have been removed in certain approval-related components.
+
+
+### Model lifecyle statuses
+
+Renamed statuses to model lifecycle status
+
+Generated PR summary:
+
+This update changes the terminology in various UI components from 'Statuses' to 'Model Lifecycle Statuses' to enhance clarity and consistency. You will notice updates in several areas, including modal headers and error messages within `AddStatusModal`. The label for the statuses section in the `SettingsSidebar` also reflects the new terminology. On the `Status` page, button labels, empty state messages, and headings are updated. Similarly, on the `StatusesWorkflows` page, titles and descriptive text are revised. Additionally, setting link titles and descriptions have been updated on the `Settings` page. These adjustments aim to provide a more consistent user experience when managing model lifecycle statuses across the application.
+
+## Bug fixes
+
+
+### Multi-organizational roles display issue
+N/A
+
+Generated PR summary:
+
+This update enhances role and permission handling within the `Template` component in the `Settings/Templates/Template/index.tsx` file. The modifications include an updated `TUserRole` type in `src/models/role.ts` to incorporate a new `scope` field. Additionally, the `Template` component now uses the `currentOrganization` from the `UsersContext`. The roles displayed for both the template's current version and selected version are now filtered based on the `currentOrganization`'s `cuid`, improving the accuracy and relevance of role-related information presented in the component.
+
From 713c8e7e8027768caa94b8b9b6c0fce2db04dcf9 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Wed, 4 Sep 2024 13:25:10 -0700
Subject: [PATCH 02/10] Edited validation guidelines release
---
site/releases/2024-may-22/release-notes.qmd | 2 +-
site/releases/2024-sep-09/release-notes.qmd | 29 ++++++++++++------
.../settings-validation-guidelines.png | Bin 0 -> 535219 bytes
3 files changed, 20 insertions(+), 11 deletions(-)
create mode 100644 site/releases/2024-sep-09/settings-validation-guidelines.png
diff --git a/site/releases/2024-may-22/release-notes.qmd b/site/releases/2024-may-22/release-notes.qmd
index 85ac825092..c61f893147 100644
--- a/site/releases/2024-may-22/release-notes.qmd
+++ b/site/releases/2024-may-22/release-notes.qmd
@@ -181,7 +181,7 @@ Our new **Generate with AI** button is now available when you edit text blocks i
Clicking on **Generate Text with AI** pops up a modal showing the AI content generation:
-{width="80%" fig-alt="A screenshot showing a text editor with a toolbar. The New Generate with AI button is available on the right."}
+{width="80%" fig-alt="A screenshot showing a text editor with a toolbar. The New Generate with AI button is available on the right"}
Here, you can choose to **Accept Text** or **Try Again**:
diff --git a/site/releases/2024-sep-09/release-notes.qmd b/site/releases/2024-sep-09/release-notes.qmd
index 7c8280bd9c..7d697b7dbf 100644
--- a/site/releases/2024-sep-09/release-notes.qmd
+++ b/site/releases/2024-sep-09/release-notes.qmd
@@ -1,5 +1,7 @@
---
title: "September 9, 2024"
+filters:
+ - tachyons
---
## Release highlights
@@ -12,21 +14,28 @@ Labels: enhancement
### Manage validation guidelines
-Added a new page in settings to manage risk areas and validation guidelines.
+:::: {.flex .flex-wrap .justify-around}
-
-
-Generated PR summary:
-
-This update brings various enhancements to the management of Risk Areas and Validation Guidelines. You will find a new `RiskAreas` page in the settings section where you can manage Risk Areas and their associated Validation Guidelines. New components such as `RiskAreaAccordionItem`, `GuidelineItem`, `UpdateGuidelineModal`, `UpdateRiskArea`, `DeleteRiskAreaModal`, and `DeleteGuidelineModal` support these functionalities.
+::: {.w-50-ns}
+
+We've expanded on our risk area functionality and added a new page to your Workplace Settings: **Risk Areas & Validation Guidelines**.
+
+This replaces the old Risk Areas set up under **Organization**, and allows you to customize guidelines associated with your model validation templates.
+
+
pFIA`@jMnm5V>Gw&?_C}HW=~FHw)&jl3`h2dt{c*uy-=Iqi
ze*IDHtlG&>YTA7bq}DK9;1crQ-%B5!rYtRv{I$i-J>$2$jFSV=rYQK ^6WjJZCeYStCL|Lv_g#nlNEWO4bB!|U!IdG8QfRYa-m*iVbws!HA5;FyC<*~Vc
zr7ruvc`NO<#<7&HRjO*$oS3d$QcBcoA1KQA1a-_eT4kz~tr9I_P3B8clLpd8ea2LPX#}e}{E~H1kTOsW!!0)@=<9joH=K?PVAP5fI^fA@`Y8nWw9cloy^)WI?
z(&423(}jKo_sH$ZaL@2Z6x>&Qy|%mf%;YF5A3MYZ?$3!+lEWdx$^aQ~`<1PA)C6#K
z3?*`TEu8t??bG`BT^B_rv&fot^|k2R0iHjXhc3yc<0k83oBhvXMpwtTNkEes$*OZ5
zs7G}DT
IDtCuyv`X!O>ZHZT9prJ`U%|ES
zJ$n78XulY#HDD3oll}J>}3y1cEq?W^})0M8~W4?3gW>g6MA2?V>aS^eGE7<4y>};bsBcH)4-z
zo-(}(?KbrapH|3@4p
+Need to start over with a model? You can now reset your model's workflow to its initial state.
-
-Generated PR summary:
-
-This release introduces several significant updates:
+
-A new reset workflow functionality is now available. You can reset workflows using the new `ResetWorkflow` API method, which sends a PATCH request to the specified endpoint. This method is easily accessible through the actions object and includes a new event renderer for displaying reset workflow events in the activity feed. A confirmation modal has been added to verify the reset action before proceeding, and once confirmed, the page reloads to reflect the changes.
+:::
-Enhancements have been made to the `EditableField` component. It now supports optional `onSave` and `onCancel` callbacks, allowing for more customizable interactions. Additionally, you can now set a custom label for the save button through the new `saveButtonLabel` prop and display extra information using the `moreInfoPopoverProps` prop with the `MoreInfoPopOver` component. The sub-component `FieldTitle` now conditionally renders tooltips or custom elements based on an override property. These enhancements are integrated into managing model status on the InventoryModelOverview page.
+::: {.w-30-ns}
-General improvements include exporting the `MoreInfoPopOver` component for reuse across different components and minor refactoring efforts aimed at improving code readability and maintainability throughout various parts of the application.
+{fig-alt="A screenshot showing the option to reset your model workflow"}
-
+
+:::
+
+::::
## Enhancements
### Model inventory fields
-Custom fields have been renamed to model inventory fields
-
-Generated PR summary:
-
-This update changes all instances of 'Custom Fields' to 'Model Inventory Fields' throughout the codebase. Several components, hooks, and pages have been edited for consistency in naming, including success and error messages, modal headers, helper texts, button labels, popover headers, sidebar labels, and toast messages. The functional behavior of the application remains unchanged; only the terminology displayed to you has been modified. Affected files include key components such as `CustomFieldModal`, `ModelInventoryTableColumnsPicker`, `CustomFieldRenderer`, and several settings-related pages and hooks. Additionally, redundant import statements have been removed in certain approval-related components.
+Previously, we used custom fields to refer to your organization's unique additional fields for models as well as the default fields provided as suggestions by ValidMind. Custom fields has been renamed to model inventory fields, capturing all additional fields, and the terminology standardized across the {{< var validmind.platform >}} and our documentation.
+
+:::: {.flex .flex-wrap .justify-around}
+
+::: {.w-70-ns}
+You can still require additional fields to be provided upon model registration, and work with a number of different types of fields.
+
+:::
+
+::: {.w-30-ns}
+
+
+
+:::
+
+::::
+
+
### Model lifecyle statuses
+Previously, we used custom fields to refer to your organization's unique additional fields for models as well as the default fields provided as suggestions by ValidMind. Custom fields has been renamed to model inventory fields, capturing all additional fields, and the terminology standardized across the {{< var validmind.platform >}} and our documentation.
+
+:::: {.flex .flex-wrap .justify-around}
+
+::: {.w-70-ns}
+You can still require additional fields to be provided upon model registration, and work with a number of different types of fields.
+
+:::
+
+::: {.w-30-ns}
+
+
+
+:::
+
+::::
+
Renamed statuses to model lifecycle status
Generated PR summary:
diff --git a/site/releases/2024-sep-09/reset-model-workflow.png b/site/releases/2024-sep-09/reset-model-workflow.png
new file mode 100644
index 0000000000000000000000000000000000000000..89dda241ce05b2418c107656d2132be1b3169cbb
GIT binary patch
literal 34783
zcmeGDbyOWq^FNBh#w9_5ySqzpcZc8(!6CSNHW1uBXmGdS?jGFT-QD4A@;u-7`>u1>
zx_{og);YhuW|(HWyQZeAx~lrqH6e=f5+C4k;K9JaK1fN5egOjmV1a>wyTC$&?$E_<
z6o7#t3R;MWC`yTl5Ggv?np%7_0Rxi^Nl=H;P#(m{(EdVP0|xjaZ0i>s5B5daJj)eQ
z2~O&};#WjSbe^Wd^~GMmXD3zBPWWIbv17W>Rz?i8c;_ku_0`<(
*Lja;xndESNd(%W>&_R(l_Ld`0ehS
z!maFW2pAm^=P$Nje2TP8#CG26{zTQk{`^Y$)n+iae$YuN3`=ZCJS<}45YEXf&tAYd
z&F5rlZk24Qp)>zjDY4z5_+dMH