Skip to content

Update docs for System Statistics label#8915

Open
marianunez wants to merge 1 commit intomasterfrom
system-statistics-lhs-name-change
Open

Update docs for System Statistics label#8915
marianunez wants to merge 1 commit intomasterfrom
system-statistics-lhs-name-change

Conversation

@marianunez
Copy link
Copy Markdown
Member

Summary

Align the docs with the admin console rename in mattermost/mattermost#36179 from Site Statistics to System Statistics so navigation and delegated-admin guidance match the UI. Preserve the legacy reporting settings anchor so existing deep links continue to resolve.

Ticket Link

https://mattermost.atlassian.net/browse/MM-67511

Made-with: Cursor

Align the docs with the admin console rename from Site Statistics to System Statistics so navigation and delegated-admin guidance match the UI. Preserve the legacy reporting settings anchor so existing deep links continue to resolve.

Made-with: Cursor
Copilot AI review requested due to automatic review settings April 21, 2026 21:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates Mattermost documentation to reflect the Admin Console rename from Site Statistics to System Statistics, while preserving legacy deep links for reporting settings.

Changes:

  • Renames “Site Statistics” to “System Statistics” across affected docs and guidance.
  • Preserves the legacy site-statistics anchor in reporting configuration docs for backward-compatible deep links.
  • Updates delegated-admin privilege labeling and related navigation instructions to match the UI.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
source/product-overview/subscription.rst Updates the statistics page label referenced in subscription billing guidance.
source/product-overview/self-hosted-subscriptions.rst Updates true-up screenshot instructions to the new System Statistics label.
source/administration-guide/onboard/delegated-granular-administration.rst Updates delegated admin “Reporting” privilege label to “System Statistics”.
source/administration-guide/manage/statistics.rst Renames the “Site statistics” section heading to “System statistics”.
source/administration-guide/manage/admin/installing-license-key.rst Updates license-usage navigation to the new System Statistics label.
source/administration-guide/configure/reporting-configuration-settings.rst Updates the section label and adds legacy site-statistics anchor for deep-link compatibility.


Site statistics
System statistics
---------------
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Editor Evie — Blocker: The section title underline is shorter than the title ("System statistics" / "---------------"), which will cause reStructuredText parsing/build errors. Suggestion: extend the underline to at least the same length as the title (e.g., use 17+ dashes to match "System statistics").

Suggested change
---------------
-----------------

Copilot uses AI. Check for mistakes.
.. _site-statistics:

System statistics
---------------
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Editor Evie — Blocker: The section title underline is shorter than the title ("System statistics" / "---------------"), which will break reStructuredText rendering for this page. Suggestion: extend the underline to at least the title length (17+ dashes).

Suggested change
---------------
-----------------

Copilot uses AI. Check for mistakes.
Bots, deactivated users, and synthetic users in :doc:`Microsoft Teams integrations </end-user-guide/collaborate/collaborate-within-connected-microsoft-teams>` and :doc:`connected workspace </administration-guide/onboard/connected-workspaces>` users aren't counted towards the total number of activated users.

You can review your activated user count in **System Console > Site Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Novice Nate — Friction: This navigation path differs from other pages updated in this PR (which use System Console > Reporting > System Statistics). Quoted: "System Console > System Statistics". Why it matters: readers may not find the page if they follow an inconsistent path. Suggestion (minimal): change to System Console > Reporting > System Statistics for consistency with the rest of the docs.

Suggested change
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.

Copilot uses AI. Check for mistakes.
| | - PERMISSION_SYSCONSOLE_WRITE_ABOUT_EDITION_AND_LICENSE |
+------------------------+--------------------------------------------------------------------------+
| Reporting | **Site Statistics** |
| Reporting | **System Statistics** |
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Veteran Vince — Friction: The UI label was updated to System Statistics, but the documented permission constants remain "...SITE_STATISTICS". Quoted: "System Statistics" next to "PERMISSION_SYSCONSOLE*_REPORTING_SITE_STATISTICS". Why it matters: admins scripting role changes may assume the permission names were renamed too and have trouble finding the right constants. Suggestion: add a brief note here that the permission constant names retain the legacy "SITE_STATISTICS" wording even though the UI page is now labeled "System Statistics".

Suggested change
| Reporting | **System Statistics** |
| Reporting | **System Statistics** |
| | Note: Permission constants retain the legacy |
| | ``..._SITE_STATISTICS`` naming. |

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA f13250b

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2026

📝 Walkthrough

Walkthrough

Documentation terminology is updated across multiple guide sections, renaming "Site statistics" to "System statistics". Changes include updating section headers, internal anchor labels, navigation paths in user instructions, configuration references, and privilege labels.

Changes

Cohort / File(s) Summary
Configuration Documentation
source/administration-guide/configure/reporting-configuration-settings.rst, source/administration-guide/manage/admin/installing-license-key.rst
Updates to system statistics section headers and navigation path references from "Site Statistics" to "System Statistics" in reporting configuration and license key installation guidance.
Administration Documentation
source/administration-guide/manage/statistics.rst, source/administration-guide/onboard/delegated-granular-administration.rst
Terminology updates to privilege labels and section headers in statistics management and delegated administration documentation, changing "Site Statistics" to "System Statistics".
Product Documentation
source/product-overview/self-hosted-subscriptions.rst, source/product-overview/subscription.rst
Updates to navigation path references in product overview documentation, reflecting the change from "Site Statistics" to "System Statistics" in System Console paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and concisely summarizes the main change: updating documentation to reflect the System Statistics label rename.
Description check ✅ Passed The description is well-related to the changeset, explaining the rationale for aligning docs with the admin console UI rename and preserving legacy anchors.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch system-statistics-lhs-name-change

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@source/product-overview/subscription.rst`:
- Line 100: Update the navigation path string "System Console > System
Statistics" to include the intermediate Reporting level so it reads "System
Console > Reporting > System Statistics" while keeping the references to "Total
Activated Users" and "Single-channel Guests" unchanged; modify the sentence in
the subscription.rst content that currently contains "System Console > System
Statistics" to the new full path for consistency with other docs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: de75be48-cc32-447e-a1b8-7f3f74097871

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac8728 and f13250b.

📒 Files selected for processing (6)
  • source/administration-guide/configure/reporting-configuration-settings.rst
  • source/administration-guide/manage/admin/installing-license-key.rst
  • source/administration-guide/manage/statistics.rst
  • source/administration-guide/onboard/delegated-granular-administration.rst
  • source/product-overview/self-hosted-subscriptions.rst
  • source/product-overview/subscription.rst

Bots, deactivated users, and synthetic users in :doc:`Microsoft Teams integrations </end-user-guide/collaborate/collaborate-within-connected-microsoft-teams>` and :doc:`connected workspace </administration-guide/onboard/connected-workspaces>` users aren't counted towards the total number of activated users.

You can review your activated user count in **System Console > Site Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use the full navigation path for consistency and accuracy.

Line 100 likely omits the intermediate Reporting level. For consistency with the rest of this PR, use System Console > Reporting > System Statistics.

Suggested minimal diff
-You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
+You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.

Based on learnings: "Describe Mattermost feature behavior, UI labels, and capability boundaries accurately."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can review your activated user count in **System Console > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
You can review your activated user count in **System Console > Reporting > System Statistics** under **Total Activated Users**. Review single-channel guest usage separately under **Single-channel Guests**.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@source/product-overview/subscription.rst` at line 100, Update the navigation
path string "System Console > System Statistics" to include the intermediate
Reporting level so it reads "System Console > Reporting > System Statistics"
while keeping the references to "Total Activated Users" and "Single-channel
Guests" unchanged; modify the sentence in the subscription.rst content that
currently contains "System Console > System Statistics" to the new full path for
consistency with other docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants