Skip to content

docs: Activity log for settings per organization#1367

Open
validbeck wants to merge 43 commits into
mainfrom
beck/sc-15647/documentation-activity-log-for-settings-org
Open

docs: Activity log for settings per organization#1367
validbeck wants to merge 43 commits into
mainfrom
beck/sc-15647/documentation-activity-log-for-settings-org

Conversation

@validbeck

@validbeck validbeck commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

sc-15647

You can now review organization-wide activity logs for records and settings/configuration changes in the ValidMind Platform. Documentation updated to add the new auditing pages, refreshed related FAQ and training content, and some minor shuffling of guides in the navigation for a cleaner experience.

How to test

Click on the live previews and confirm the major changes are good/accurate:

Guides

OLD NEW Changes
Guides Guides Renamed the Reporting section to Reporting & auditing and added the "Tracking organization activity" topic.

Configuration

OLD NEW Changes
Managing your organization Managing your organization Moved the document defaults content and the private connectivity guides (both moved to other pages/sections).
Manage platform notifications Manage platform notifications Rehomed under the organization management section.
Net-new page Configuring private connectivity New landing page for AWS PrivateLink, Google Private Service Connect, and Azure Private Link configuration.

Integrations

OLD NEW Changes
Configure analytics exports Configure data exports Renamed analytics exports to data exports and expanded the page to include inventory, artifact, record activity, and settings activity datasets.

Documents & templates

OLD NEW Changes
Working with document templates Working with document templates Moved this above "Managing documents" in the side navigation.
Manage text block library Manage text block library Moved this under "Working with templates" accordian section.
Working with documents Managing documents Renamed and cleaned up this page.

Reporting

OLD NEW Changes
Net-new page Tracking organization activity Added a new landing page for record and settings activity logs.
View record activity View record activity Moved record activity from Inventory to Reporting & auditing, and added a redirect from the old filepath.
Net-new page View settings activity New instructiond for auditing settings and configuration changes.

Support / FAQ

Links out to the updated FAQ sections also included on relevant pages.

OLD NEW Changes
FAQ FAQ Reordered FAQ topics and added the new Attestations topic.
Integrations and support Integrations and support Added a third-party integrations answer covering registries, ticketing, reporting exports, webhooks, library integrations, MCP, and custom integrations.
Workflows and lifecycles Workflows and lifecycles Updated workflow terminology from statuses to record stages and refreshed related links.
Inventory and activity Inventory Narrowed the topic to inventory, added clearer customization/export answers, and pointed activity coverage to the new reporting/auditing pages.
Documents and templates Documents and templates Added answers for reusable content, external or historical documents, document checker use, document updates, and expanded export options.
Validation and artifacts Validation and artifacts Added artifact activity/export context and updated validation, assessment, and artifact-management references.
Collaboration Collaboration Moved record and settings activity answers from old Inventory FAQ page here using the new shared FAQ snippets.
Ongoing monitoring and reporting Reporting and ongoing monitoring Added record/settings activity coverage and a scheduled data exports answer for inventory, artifacts, record activity, and settings activity.
Net-new page Attestations Added a new FAQ topic for attestation roles, timing, snapshots, rejections, exports, and template lifecycle behavior.

Training

Administrator Fundamentals

Click through to the next 2 slides:

OLD NEW Changes
Organizational Oversight
& Reporting
Organizational Oversight
& Reporting
Added settings and record activity training material and updated tracking/exports slides.

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

Some entries on the log aren't showing up, will be dealt with in https://app.shortcut.com/validmind/story/16674/organization-settings-support-workflows-and-attestations-activities — will update docs again once that is completed.

Release notes

Covered by:

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)

@validbeck validbeck self-assigned this Jun 10, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Jun 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This pull request makes extensive updates across documentation and configuration files in the project. The changes primarily focus on refining navigation, updating alias paths, and renaming labels to improve consistency and clarity in the user interface. Key changes include:

  • Renaming and redirecting various document links from legacy paths (e.g. from /guide/inventory/view-record-activity.qmd to /guide/reporting/view-record-activity.qmd) to improve the organizational structure of activity and reporting pages.
  • Replacing references such as "Working with documents" with more explicit terminology like "Managing documents" to reduce ambiguity.
  • Adjusting sidebar configuration and updating related links in the _sidebar.yaml file, ensuring that sections like Integrations, Documents & Templates, and Reporting & Auditing are consistently represented.
  • Updates to FAQ files, release notes, and onboarding guides to reflect new labels (e.g. use of "Data Exports" instead of "Analytics Exports") and refactored navigation towards activity, reporting, and settings pages.
  • Minor CSS adjustments to add breathing room after intro listing tiles, improving the presentation of the documentation.
  • Several training slides and developer guides have been updated to point to the new paths so that users are directed to the correct pages when attempting to view record or settings activity.

Overall, the changes aim to enhance usability, consistency, and logical grouping of documentation content, thereby reducing confusion for users navigating documentation and configuration settings related to activity logs and export features.

Test Suggestions

  • Verify that all updated links redirect correctly to the new paths (e.g., verify /guide/reporting/view-record-activity.qmd instead of legacy inventory links).
  • Ensure that the updated labels (e.g., Managing documents, Data Exports, Reporting & Auditing) appear correctly in the sidebar and navigation menus.
  • Test the navigation in both the documentation site and in training modules to confirm that interactive elements, buttons, and links render the correct content.
  • Perform a cross-browser review of styling changes (e.g., extra bottom margin added to intro listings) to ensure consistent presentation.

@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@validbeck validbeck requested a review from nateshim June 10, 2026 23:01
- **Webhook Secrets** to view activity related to webhook secret creation, revocation, and deletion.^[[Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets)]
- **Workflows** to view activity related to workflow creation, publications, and deletions.^[[Setting up workflows](/guide/workflows/setting-up-workflows.qmd)]

When enough activity categories are displayed, click {{< fa chevron-left >}} or {{< fa chevron-right >}} to scroll through left or right respectively through the list.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@validbeck there was an update we no longer have this and instead use the filter button by event type

@nateshim nateshim left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

left a comment regarding updates to tabs in org activity but other than that lgtm thanks!

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