Skip to content

Merge staging into prod#1317

Merged
nrichers merged 4 commits intoprodfrom
staging
May 6, 2026
Merged

Merge staging into prod#1317
nrichers merged 4 commits intoprodfrom
staging

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented May 6, 2026 •
edited
Loading

Pull Request Description

What and why?

This PR publishes some 26.05 docs updates and refreshes our release notes.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

nrichers and others added 4 commits May 4, 2026 14:30
@nrichers
docs: Map and assess evidence (#1299)
e6a1f06 
* docs: Add autogenerate validation reports documentation

Document the AI-powered features for validators:
- Auto-Link Evidence for single/bulk guideline evidence linking
- Risk Assessment Generation for single/bulk assessments
- Understanding the structured AI-generated assessment format

Closes sc-14812.

* fix: Rename to map-and-assess-evidence with accurate UI terminology

- Rename file from autogenerate-validation-reports.qmd to map-and-assess-evidence.qmd
- Update title to "Map and assess evidence"
- Fix UI element names to match actual product (Map Evidence, Assess Evidence)
- Describe Evidence Assessment output structure accurately
- Add relevance threshold slider documentation

* Add screenshots for Map Evidence and Assess Evidence panels

- Add map-evidence-panel.png showing evidence type toggles and relevance threshold
- Add assess-evidence-panel.png showing compliance assessment option
- Display both in column-margin divs alongside their respective sections

* fix: Add Approve All / Reject All workflow for Map and Assess Evidence

- Update Map Evidence steps to describe approve/reject workflow
- Update Assess Evidence steps to describe approve/reject workflow
- Clarify that editing is available after approving assessments

* Add individual approve/reject, relevance analysis, and reassess options

- Add individual Approve/Reject buttons for mapped evidence
- Add See Relevance Analysis option with relevance score explanation
- Add individual Approve/Reject buttons for evidence assessments
- Add Reassess Evidence option to regenerate assessments
- Add new "Understand mapped evidence" section explaining relevance scores and analysis

* Distinguish report-level vs section-level approve/reject workflows

- Report overview: Approve All / Reject All for entire report
- Section-level: Individual Approve / Reject per evidence item or assessment
- Clarify the two-level review structure for both Map Evidence and Assess Evidence

* Consolidate intro into benefits-focused overview section

Replace detailed "Understand mapped evidence" and "Understand evidence
assessments" sections with a concise "How do evidence mapping and
assessment work?" section that explains the benefits for new users.

* Format overview section as definition list

* Remove What's next section

* Remove unused evidence-assessment-example.png

* Add What's next section with listing to assess-compliance

Links to the manual compliance assessment workflow for users who
prefer traditional evidence linking and assessment selection.

* Document Remap Evidence button in report overview

* Replace 'report overview' with visible UI terminology

Changed 'From the report overview' to 'For the entire report' and
removed references to non-existent 'Overview page' label.

* Simplify navigation: click Validation link directly

* Address review comments from Fernanda

* Fix link warning
@github-actions
Merge remote-tracking branch 'origin/main' into staging
24b9c89
@github-actions
Merge pull request #1315 from validmind/update-staging-25344628772
8bd7c72 
PR#1299 — Merge main into staging
@nrichers
docs: Add Databricks integration documentation (#1301) (#1316)
2270955 
* docs: Add Databricks Unity Catalog integration documentation

Add documentation for the new Databricks integration that enables
linking ValidMind inventory records to Databricks Unity Catalog
resources including models, datasets, and agents.

- Add Databricks to supported connections in configure-connections.qmd
- Add Databricks to model inventory integrations in managing-integrations.qmd
- Add step-by-step connection and linking examples in integrations-examples.qmd

Closes sc-14813

* Add placeholder columns to integrations grid layout

* Fix Databricks connection field names to match UI

- databricks host → workspace url
- client id → sql warehouse id
- client secret → personal access token

* Fix Databricks link model steps to match UI

* docs: Fix Databricks connection field descriptions

- client id: Update to describe SQL Warehouse ID
- client secret: Update to describe PAT token secret

* docs: Add developer workflow for running validations on Databricks data

Add a new section explaining how to run validation notebooks against
Databricks-hosted data, with a link to the quickstart notebook and a
mermaid diagram showing the data flow between platforms.

* Split examples up into separate files.

* File rename

* Remove terminology ambiguity

* Edits

* Add missing headings for steps

* Add configuration screenshot
@nrichers nrichers added the internal Not to be externalized in the release notes label May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

PR Summary

This PR introduces extensive updates to the documentation and integration examples used by the platform. The key changes include:

  1. Sidebar and Listing Updates:

    • The _sidebar.yaml now uses a nested structure for the integrations examples, switching from a single file link to a structured format that lists individual integration example pages. This facilitates better organization and navigation in the guides.

  2. New and Enhanced Integration Documentation:

    • Added details for a new Databricks connection in the configure-connections guide. This update provides requirements (such as the host URL, client id, and client secret) needed to configure a Databricks integration.
    • Multiple new integration example pages have been added (e.g., Create Jira ticket, Create ServiceNow incident, Synchronize models with AWS Bedrock, AWS SageMaker, GitLab, and Databricks, and using webhooks with workflows). Each page includes instructions, prerequisites, sample payloads, and screenshots to guide users through configuring and linking their external systems.

  3. Evidence Mapping and Assessment for Model Validation:

    • A new documentation file for "Map and assess evidence" has been introduced. This document explains how to use AI-assisted evidence mapping to suggest, review, and approve evidence related to model validation. It outlines the process for mapping relevant evidence to validation guidelines and subsequently generating structured compliance assessments.

These changes collectively enhance the user experience by providing detailed, step-by-step integration setups and improved functionality documentation that supports both integration configuration and model validation processes.

Test Suggestions

  • Verify that the new structured sidebar displays all integration examples correctly and that nested content (especially for the integrations listing) is rendered as expected.
  • Check that navigation to each of the new integration example pages (Databricks, AWS SageMaker, AWS Bedrock, GitLab, Jira, ServiceNow, and Webhook examples) works correctly and that the sample code blocks and images are rendered properly.
  • Ensure the new Databricks integration instructions display all required fields and the test connection workflow operates as described.
  • Review the new 'Map and assess evidence' page to confirm that the evidence mapping and assessment process (including screenshots and workflow instructions) is clear and accessible.
  • Test the overall layout to make sure that the changes to the grid/listing formats (including column widths in the sidebar) do not break the responsive design.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@nrichers nrichers merged commit 545684f into prod May 6, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nrichers