docs: PRT final audit — Integrations

[validbeck]

Pull Request Description

What and why?

sc-16491

Final phase within docs for the models > records scrub; reorganized and edited the integration docs.

How to test

Click on the live previews and review the changed content:

Integrations Branch Changelog

OLD	NEW	Changelog
Managing integrations	Managing integrations	Moved key concepts earlier; changed model inventory, lifecycle, API, and MCP wording to inventory and records; wrapped integration capability sections in a tabset.
Manage secrets	Manage secrets	Reorganized integration and webhook secret tasks into view, add/edit, and revoke/delete tabsets; added collapsible guidance for expiring secrets and webhook secret usage; updated deletion callouts and menu wording.
Configure connections	Configure connections	Shifted wording from models to records; added connection detail, edit, and test sections; reorganized monitoring guidance into tabs; expanded Bedrock metric-source explanation; updated custom integration terminology.
Implement custom integrations	Implement custom integrations	Reworked structure around how custom integrations work; added bidirectional sync details; reorganized API/reference examples into tabs; added UI steps for adding integrations and linking records/artifacts; moved best practices into a collapsible callout.
Link external models	Link external records	Renamed page and file; added alias from old URL; updated model-linking language to record-linking language throughout; removed inline screenshots; simplified repeated inventory footnotes.
Configure analytics exports	Configure analytics exports	Updated model/finding terminology to records/artifacts; added view details and run history guidance; reorganized edit, enable/disable, delete, and run-now tasks; updated dataset names and explanatory footnotes; removed inline screenshots.
Create a Jira ticket	Create a Jira ticket	Simplified the page by replacing duplicated workflow setup with shared includes; changed model validation language to broader validation; added Jira include metadata and updated links to absolute guide paths.
Create a ServiceNow incident	Create a ServiceNow incident	Replaced duplicated workflow setup with shared includes; reorganized the steps into add workflow, configure step, and publish workflow tabs; updated links to absolute guide paths.
Synchronize models with AWS Bedrock	Synchronize records with AWS Bedrock	Renamed from models to records; added a Bedrock integration overview; reorganized configure/link steps into a tabset; added optional connection test details and a record dependency callout.
Synchronize models with AWS SageMaker	Synchronize records with AWS SageMaker	Renamed from models to records; reorganized configure/link steps into a tabset; clarified AWS SageMaker naming and credential scope; moved screenshot into a footnote.
Synchronize with Databricks	Synchronize with Databricks	Kept title; moved prerequisites below concept content; reorganized configure/link tasks into a tabset; fixed duplicate Link Model step; moved screenshot into a footnote and updated links.
Synchronize models with GitLab	Synchronize records with GitLab	Renamed from models to records; reorganized connection and linking steps into a tabset; added explicit connection testing; moved screenshot into a footnote and updated links.
Use webhooks with workflows	Use webhooks with workflows	Renumbered workflow sections and substeps; updated webhook payload wording from model CUID to target record/model CUID; converted links to absolute guide paths.

What needs special review?

I can't really test some of these instructions as I don't have access to the integration platforms, but I tried to review the frontend/backend code to identify what made sense to change and what didn't based on the context of the integration. Refer to below for more info.

Dependencies, breaking changes, and deployment notes

Important

Some of the UI instructions rely on the changes requested in this PR to be applied: https://github.com/validmind/frontend/pull/2587#pullrequestreview-4384010798

Release notes

n/a

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)

[even-steven]

✅

[github-actions]

PR Summary

This PR focuses on several documentation and UI text improvements across the project. The changes include:

• Updating the language in various guides to ensure consistency in UI interactions by replacing phrases like "appears" with "menu appears" when describing the behavior of dropdowns and action menus. This change improves clarity for users when interacting with the interface.
• Renaming references from "external models" to "external records" in multiple files. This language update reflects a broader conceptual change where inventory items are more generally referred to as records rather than models.
• Adjustments to formatting in the documentation pages to standardize instructions (such as labels for buttons and menu interactions) and to enforce consistent use of UI icons.
• Minor reordering and reformatting of sections (such as prerequisite lists and key concept panels) across various guides including integrations, inventory, workflows, templates, validation, and reporting.

Overall, these updates help maintain uniformity in user-facing documentation and in the descriptions of UI behaviors in the platform.

Test Suggestions

• Manually verify that all dropdown menus and action menus now display the phrase "menu appears" rather than just "appears" when hovered over in the UI.
• Review pages that reference external systems to confirm that all instances of "external models" have been correctly renamed to "external records" with no unintended breakage in links or cross-references.
• Ensure that all UI guidance (icons and button labels) in the documentation match actual UI behavior in the product.
• Perform a full regression test on the documentation site to check for broken links or formatting issues related to the extensive text and formatting changes.

[github-actions]

Validate docs site

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