Skip to content

Publish to prod: 2026 May 7#1319

Merged
validbeck merged 4 commits intoprodfrom
staging
May 7, 2026
Merged

Publish to prod: 2026 May 7#1319
validbeck merged 4 commits intoprodfrom
staging

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 7, 2026

Pull Request Description

What and why?

The following changes should show up on prod:

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 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
* WIP

* model-documentation > documentation

* model-validation > validation

* Removing wrong aliases from inventory/

* Aliases for renamed directories

* Renaming some files in documentation/

* Reverting notebooks to main, forgor to tell Cursor to ignore

* Renaming some files in validation/

* Edit: Working with documentation

* Edit: View development guidelines

* Save point

* Edit: Work with content blocks

* WIP

* Edit: Work with content blocks

* Edit: Work with document versions

* Edit: Assign development section statuses

* Edit: Check documents for compliance

* Edit: Collaborate with others

* Submit for approval > Submit documents

* Edit: Submit documents

* Save point

* Updating content of relevant glossary entries

* Editing site/documentation/ related training slides

* Manage model stages > Manage record stages

* save point

* Edit: Manage record stages

* Edit: Introduction to workflows

* Edit: Workflow step types

* Edit: Conditional requirements

* Renaming: Conditional requirements > Conditional step requirements

* Edit: Workflot states & correcting .gitignore

* Edit: Setting up workflows

* Edit: Configure workflows

* WIP: Workflow configuration examples

* Edit: Manage workflows

* Save point

* Save point

* Edit: Transition workflows

* Edit: Manage workflow tasks

* Proofreading workflows/

* Edit: Workflows in training

* Renaming some files in validation/

* Edit: Managing validation

* Edit: Manage validation guidelines

* Edit: Manage artifact types

* Edit: Manage artifact severities

* Edit: Manage artifact fields

* Save point

* Edit: Preparing validation reports

* Save point

* Save point

* Edit: Assess compliance

* Save point

* Save point

* Edit: View & filter artifacts

* Edit: Customize artifact layouts

* Edit: Add & manage artifacts

* Edit: Customize artifact overview page

* Save point

* Save point

* Renaming some files in templates/

* Edit: Working with documents

* Save point

* Edit: Manage document types

* Edit: Manage documents

* Save point

* Edit: Manage text block library

* Proofreading templates/

* Edit: access/

* Edit: Managing your organization

* Edit: Managing users

* Edit: Personalizing ValidMind

* Edit: Manage platform notifications

* proofread

* Map & assess accuracy edits

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
@validbeck validbeck self-assigned this May 7, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 7, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

PR Summary

This pull request makes extensive text and link updates across many Quarto (.qmd) files in the repository. The primary focus is to rebrand documentation from using terms such as "model", "model documentation", "model validation", and related phrases to more generic terms like "record", "documentation", and "validation". In addition, the changes update references to various paths and includes (e.g., from /guide/model-documentation/ to /guide/documentation/, and /guide/model-validation/ to /guide/validation/) ensuring consistency with the new naming convention.

Other changes include updating links to workflow configurations, stage management, inventory field management, and artifact handling. The alias names, button labels, tooltips, headings, and descriptions have all been revised so that the terminology now refers to records or inventory records rather than models. This is evident in updates across multiple directories including releases, training materials, and guides. Overall, the PR standardizes the language throughout so that users see consistent terminology in the user interface, documentation, and training content.

The functional changes are purely cosmetic and editorial, designed to improve clarity and consistency in the documentation management system without altering underlying application logic.

Test Suggestions

  • Manually navigate through the affected pages (documentation guides, training materials, workflow and inventory pages) to ensure that all links have been updated correctly and point to the new paths.
  • Verify that the new terminology appears consistently across the user interface (e.g., sidebars, buttons, tooltips, document titles) and that no residual old text remains.
  • Check that the updated Quarto includes and alias references are processed correctly in the rendered output.
  • Perform a text search for old patterns such as 'model-documentation' or 'model-validation' in the website output to ensure no outdated references remain.
  • Run the full documentation build to verify that there are no broken links or compilation errors.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Validate docs site

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

@validbeck validbeck merged commit cbd67b5 into prod May 7, 2026
8 of 9 checks passed
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