Skip to content

Huge product renaming release & cleanup#562

Merged
validbeck merged 59 commits intomainfrom
beck/sc-6648/add-release-note-item-about-name-change-to
Dec 6, 2024
Merged

Huge product renaming release & cleanup#562
validbeck merged 59 commits intomainfrom
beck/sc-6648/add-release-note-item-about-name-change-to

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Dec 3, 2024

Internal Notes for Reviewers

sc-6648

Release notes

December 6, 2024

LIVE PREVIEW

HUGE release including comprehensive information about the recent product renaming, and some highlights and backfill of the really neat things we've done with the site (I felt they deserved a highlight this time!):

Release highlights
  • ValidMind Library (v2.5.25): ValidMind Developer Framework > ValidMind Library, RAG Model Documentation Demo
  • ValidMind Platform (v1.27.7): ValidMind Platform UI > ValidMind Platform, Submit product feedback directly, Support for custom analytics
  • Documentation: Updated product terminology, New ValidMind branding, ValidMind Academy portal, ValidMind LLM feature overview
Enhancements
  • ValidMind Library (v2.5.25): Added parameter grid support in comparison tests
  • ValidMind Platform (v1.27.7): (There we so many, I grouped them into topic!) User experience, Model workflows, Model inventory fields, Model documentation
Bug fixes

There weren't that many, and they weren't that detailed — just some brief bullet point summaries.

Documentation
  • User guide updates: (There we so many, I grouped them into topic!) Configuration, Model inventory, Model documentation, Model validation, Reporting, Developers, Feature renaming (uncertain if we want to include this last one, but I thought it was nice to give users the complete picture)
  • ValidMind Academy updates: Updated validator training
  • Site enhancements: (There we so many, I grouped them into topic!) Mobile responsive redesign, Style and accuracy edits, Authoring enhancements, 404 page

Highlights CSS class

There's now a new CSS class I've applied to the "Highlights" of releases:

.highlights {

I decided the highlights needed to look a bit different than the rest of the releases page, especially when we have so much neat stuff to go over!

Old New
Screenshot 2024-12-03 at 12 09 49 PM Screenshot 2024-12-03 at 12 15 16 PM

Training

The lightbox CSS hadn't been applied to the training slides, so I fixed that and also the font weirdness.

Old New
Screenshot 2024-12-03 at 12 06 56 PM Screenshot 2024-12-03 at 12 15 42 PM

@validbeck validbeck added the internal Not to be externalized in the release notes label Dec 3, 2024
@validbeck validbeck self-assigned this Dec 3, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 3, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 3, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Copy Markdown
Collaborator Author

@mehdi0501 @kristof87

Here are the latest very detailed release notes capturing the recent product release! Please let me know if anything needs to be adjusted or if it looks good to go. 🙏🏻

LIVE PREVIEW: December 6, 2024

Quick excerpts:

Release highlights

ValidMind Library (v2.5.25)

Screenshot 2024-12-03 at 12 29 36 PM

ValidMind Platform (v1.27.7)

Screenshot 2024-12-03 at 12 30 34 PM

Documentation

Screenshot 2024-12-03 at 12 31 12 PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 3, 2024

PR Summary

This pull request introduces several enhancements and bug fixes across various components of the project. Key changes include:

  1. Documentation Enhancements:

    • Updated product terminology to reflect new branding, including renaming the Developer Framework to ValidMind Library and the Platform UI to ValidMind Platform.
    • Improved documentation homepage with new quick links, sections, and search functionality.
    • New branding applied to documentation with updated logo and theme.
    • Enhanced training portal with a new theme and landing page.
    • Added a guide for large language model (LLM) features.
  2. Platform Enhancements:

    • New feature to submit product feedback directly within the platform.
    • Support for custom analytics, allowing users to add, edit, or remove custom data in analytics.
    • Updated user interface theme to match new branding.
    • Added support for attaching files on workflow transitions and configuring divergent paths in workflows.
    • Ability to configure calculated model inventory fields and add descriptions to attachments.
  3. Developer Library Enhancements:

    • Added parameter grid support in comparison tests.
    • Introduced a new RAG Model Documentation Demo notebook.
  4. Bug Fixes:

    • Corrected the last updated value for templates to reflect the correct modification date.
    • Resolved display issues when managing user roles.

These changes aim to improve user experience, enhance documentation clarity, and provide more flexible features for model risk management.

Test Suggestions

  • Verify the updated product terminology is reflected across all documentation and UI components.
  • Test the new feedback submission feature within the platform to ensure it functions correctly.
  • Check the custom analytics feature by adding, editing, and removing custom data.
  • Ensure the new UI theme is applied consistently across the platform.
  • Test the file attachment feature in workflow transitions to confirm it works as expected.
  • Validate the functionality of calculated model inventory fields and attachment descriptions.
  • Run the RAG Model Documentation Demo notebook to ensure it executes without errors.
  • Check that the last updated value for templates is accurate after modifications.
  • Verify that user role management displays correctly without any UI issues.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 3, 2024

PR Summary

This pull request introduces several enhancements and updates across various components of the project:

  1. Documentation Enhancements:

    • Added a new release note for December 6, 2024, detailing significant updates including product renaming, new training courses, and LLM features.
    • Updated product terminology across user guides and external documentation to reflect new product names.
    • Refreshed the documentation site with new branding, including updated colors, logos, and a new homepage layout.
    • Introduced a new training portal with a distinct theme and landing page.
    • Improved inline link styling and added lightbox-style images for better readability.
  2. UI and UX Improvements:

    • Updated the ValidMind Platform's theme to match the new branding, featuring a new logo and accent color.
    • Added support for attaching files on workflow transitions and configuring divergent paths in workflows.
    • Enhanced model inventory fields with calculated fields and the ability to add descriptions to attachments.
    • Improved user experience with a new mobile-responsive design for the documentation site.
  3. New Features:

    • Introduced a new feature for submitting product feedback directly within the ValidMind Platform.
    • Added support for custom analytics, allowing users to add, edit, or remove custom data in analytics.
    • Implemented a new AI terms of use acceptance process for new and existing users.
  4. Bug Fixes:

    • Fixed issues with template last updated dates and user role display in the user directory.
  5. Security and Code Quality:

    • No specific security concerns were identified in this update.
    • Code quality improvements include better organization and consistency across documentation and UI components.

Test Suggestions

  • Verify the new product names are correctly updated across all documentation and UI components.
  • Test the new training portal for accessibility and content accuracy.
  • Check the functionality of the new feedback submission feature within the ValidMind Platform.
  • Ensure the new custom analytics feature allows for correct data manipulation and visualization.
  • Test the mobile responsiveness of the updated documentation site on various devices.
  • Verify the AI terms of use acceptance process works for both new and existing users.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 3, 2024

PR Summary

This pull request introduces several enhancements and bug fixes across various components of the project. Key changes include:

  1. Documentation Enhancements:

    • Updated product terminology to reflect new branding, including renaming the Developer Framework to ValidMind Library and the Platform UI to ValidMind Platform.
    • Improved documentation homepage with new quick links, sections for training collateral, and updated search functionality.
    • New branding applied to documentation with updated logo and theme.
    • Expanded training portal with a new theme and landing page.
    • Added a guide for large language model (LLM) features.
  2. Platform Enhancements:

    • New user interface theme matching the main website and documentation.
    • Ability to submit product feedback directly within the platform.
    • Support for custom analytics, allowing users to add, edit, or remove custom data in analytics.
    • Enhanced model workflows with support for attaching files and configuring divergent paths.
    • New model inventory fields with calculated fields and attachment descriptions.
  3. Developer Library Enhancements:

    • Added parameter grid support in comparison tests.
    • Updated CI workflow configuration for better compatibility and notifications.
  4. Bug Fixes:

    • Corrected last updated value for templates.
    • Resolved display issues in user role management.

These changes aim to improve user experience, streamline documentation processes, and enhance the functionality of the platform and developer tools.

Test Suggestions

  • Verify the updated product terminology is reflected across all documentation and UI components.
  • Test the new documentation homepage for correct links and search functionality.
  • Check the new branding is consistently applied across the documentation and platform.
  • Ensure the training portal's new theme and landing page are functioning as expected.
  • Test the LLM feature guide for accuracy and completeness.
  • Verify the new UI theme is applied correctly and consistently across the platform.
  • Submit feedback through the platform and ensure it is processed correctly.
  • Add, edit, and remove custom analytics data and verify the changes are reflected in reports.
  • Test the new model workflows for file attachment and divergent path configuration.
  • Verify the functionality of new model inventory fields, including calculated fields and attachment descriptions.
  • Run comparison tests with parameter grids and verify the results.
  • Check the CI workflow for compatibility and notification functionality.
  • Ensure the last updated value for templates is accurate.
  • Test user role management for correct display and functionality.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 5, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 5, 2024

A PR preview is available: Preview URL

Copy link
Copy Markdown
Collaborator

@kristof87 kristof87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The areas that I was involved in look good to me. Thank you, Beck!

@validbeck validbeck merged commit 271191c into main Dec 6, 2024
@validbeck validbeck deleted the beck/sc-6648/add-release-note-item-about-name-change-to branch December 6, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants