Skip to content

Merge main into staging#1316

Merged
nrichers merged 2 commits intostagingfrom
fix-merge-conflict-may-5-2026
May 6, 2026
Merged

Merge main into staging#1316
nrichers merged 2 commits intostagingfrom
fix-merge-conflict-may-5-2026

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented May 5, 2026

Pull Request Description

What and why?

We got a rare merge conflict between main and staging which this PR fixes.

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 added 2 commits May 5, 2026 09:41
* 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 5, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

PR Summary

This PR enhances the integrations section of the documentation by introducing several new and improved integration examples and updating the sidebar configuration. The key changes include:

  • Modifications in the sidebar YAML file to change how integration examples are referenced. Instead of a single file path, the new format uses a detailed listing with a separate set of content files for each integration example.

  • Addition of detailed documentation pages for various integrations, such as:

    • Creating Jira tickets via HTTP requests
    • Creating ServiceNow incidents using webhooks
    • Synchronizing models with AWS SageMaker and AWS Bedrock
    • Synchronizing models with GitLab
    • Integrating with Databricks including a quickstart guide, detailed configuration steps, and how to link records
    • Using webhooks to start or resume workflows
  • Updates to the Databricks integration documentation, including an explanation of how Unity Catalog resources are synchronized and a mermaid diagram to illustrate the data flow.

These changes provide clearer guidance on configuring the connections and workflows, and offer a more structured and detailed approach to integrating with external systems using the platform.

Test Suggestions

  • Verify that the updated sidebar correctly renders the new file structure and navigation links for integration examples.
  • Check that all new integration example pages render properly in different browsers and on various devices.
  • Test the code samples (e.g., HTTP request payloads, webhook configurations, curl commands) to ensure they are correct and lead to expected behaviors in a staging environment.
  • Validate that images (screenshots) referenced in the documentation are loading correctly and have appropriate alt texts.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Validate docs site

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 7257fa4

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.69 1.00 0.82
/get-started/get-started.html 0.85 0.70 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.69 1.00 0.82
/releases/all-releases.html 0.86 0.70 1.00 0.73
/support/support.html 0.91 0.66 1.00 0.82
/training/training.html 0.85 0.66 0.96 0.73

@nrichers nrichers merged commit 2270955 into staging May 6, 2026
10 checks passed
@nrichers nrichers deleted the fix-merge-conflict-may-5-2026 branch May 6, 2026 00:07
nrichers added a commit that referenced this pull request May 6, 2026
* docs: Map and assess evidence (#1299)

* 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

* docs: Add Databricks integration documentation (#1301) (#1316)

* 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

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

1 participant