-
Notifications
You must be signed in to change notification settings - Fork 599
AI-Aided: Add documentation for Load Metric field in About dialog #8103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Create new documentation file for viewing system information - Document the About dialog accessible via profile menu - Add Load Metric field documentation for Mattermost v10.10+ - Update messaging collaboration guide to include new documentation - Load Metric provides contextual server activity data for support 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
Newest code from mattermost has been published to preview environment for Git SHA d3c9fef |
Newest code from mattermost has been published to preview environment for Git SHA ddec854 |
Load metric | ||
------------ | ||
|
||
From Mattermost v10.10, system admins have access to an additional diagnostic data point when working with Mattermost support by going to the **Product** menu |product-list| and selecting **About Mattermost**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This information is not limited to system admins: it's intentionally exposed to any regular user of the system.
|
||
From Mattermost v10.10, system admins have access to an additional diagnostic data point when working with Mattermost support by going to the **Product** menu |product-list| and selecting **About Mattermost**. | ||
|
||
The **Load Metric** field displays current server activity levels and usage patterns, giving Mattermost support teams a contextual reference point for understanding deployment characteristics without requiring access to detailed logs, configurations, or sensitive system data. System admins may need to reference this value when working with Mattermost support teams in environments where Support Packet generation is restricted or prohibited. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we shouldn't just be explicit that we're computing a monthly active users metric relative to the total number of licensed users?
- **Mattermost Version**: The current version of the Mattermost server | ||
- **Database Schema Version**: The version of the database schema in use | ||
- **License**: Information about your Mattermost license (if applicable) | ||
- **Build Information**: Details about the server build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add the load metric in this list?
@claude - Incorporate @lieut-data's inline feedback, and ensure that the |
Claude finished @cwarnermm's task —— View job I've successfully incorporated @lieut-data's inline feedback and verified the navigation structure for the new documentation file. Completed Tasks:
Changes Made:
Navigation Structure:The
The file should be accessible in the left-hand nav pane under: End User Guide → Messaging Collaboration → View system information All review feedback has been addressed and changes committed to the PR branch. The documentation should build and display correctly with the updated navigation structure. |
… definition, and add load metric to About dialog list - Change "system admins have access" to "all users have access" for load metric visibility - Specify load metric as "monthly active users relative to licensed users" for clarity - Add Load Metric field to the About dialog information list in view-system-information.rst Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
Newest code from mattermost has been published to preview environment for Git SHA b785f02 |
Newest code from mattermost has been published to preview environment for Git SHA a2db837 |
Newest code from mattermost has been published to preview environment for Git SHA 9d9cce5 |
Newest code from mattermost has been published to preview environment for Git SHA 4c13039 |
Newest code from mattermost has been published to preview environment for Git SHA bf9df9b |
This PR adds documentation for the new Load Metric field that will be visible in the About > Mattermost dialog starting from Mattermost server v10.10 via mattermost/mattermost#30700
Changes
Created new documentation file:
source/collaborate/view-system-information.rst
Updated messaging collaboration guide:
source/guides/messaging-collaboration.rst
Load Metric Field
The Load Metric field reflects server activity levels and is used by Mattermost support teams as a reference point when assisting with deployments, particularly when support packets or site statistics cannot be shared externally.
Closes #8101
Generated with Claude Code