MM-67771: Update Report a Problem default behavior docs#8845
MM-67771: Update Report a Problem default behavior docs#8845
Conversation
Update the "Default link" description to reflect the new behavior: licensed servers now open an email to Mattermost support, and free edition directs to the troubleshooting forums. Also fix typo in REPORTAPROBLMEMAIL env var name. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughUpdated documentation for the "Report a Problem" site configuration setting: clarified the Default behavior to state licensed deployments open a support case by email to Mattermost support, unlicensed/community deployments are directed to troubleshooting forums, and fixed a typo in the environment variable name from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
Newest code from mattermost has been published to preview environment for Git SHA 4a5b018 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
vish9812
added
1: PM Review
|
Newest code from mattermost has been published to preview environment for Git SHA 4a5b018 |
|
@vish9812 please rebase to the v11.7 (if that's correct?) branch when it's cut in the next few days |
esethna
added
Do Not Merge/Awaiting Next Release
There was a problem hiding this comment.
🧹 Nitpick comments (1)
source/administration-guide/configure/site-configuration-settings.rst (1)
256-256: Consider using consistent terminology.The description uses "Customers with a Mattermost license" and "Unlicensed Mattermost deployments". For consistency with terminology used elsewhere in this documentation (e.g., "licensed deployments" and "unlicensed deployments"), consider standardising the phrasing.
♻️ Suggested terminology alignment
-- **Default**: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_. +- **Default**: Licensed deployments can open a support case by email with the Mattermost support team. Unlicensed deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/administration-guide/configure/site-configuration-settings.rst` at line 256, Update the phrasing in the sentence that currently reads "Customers with a Mattermost license" and "Unlicensed Mattermost deployments" to use consistent terminology used elsewhere (e.g., change to "licensed deployments" and "unlicensed deployments"); locate the sentence in site-configuration-settings.rst (the Default: line) and replace the first clause with "licensed deployments" so the full sentence uses "licensed deployments can open a support case by email with the Mattermost support team. Unlicensed deployments are directed to the troubleshooting forums..." to match existing docs terminology.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@source/administration-guide/configure/site-configuration-settings.rst`:
- Line 256: Update the phrasing in the sentence that currently reads "Customers
with a Mattermost license" and "Unlicensed Mattermost deployments" to use
consistent terminology used elsewhere (e.g., change to "licensed deployments"
and "unlicensed deployments"); locate the sentence in
site-configuration-settings.rst (the Default: line) and replace the first clause
with "licensed deployments" so the full sentence uses "licensed deployments can
open a support case by email with the Mattermost support team. Unlicensed
deployments are directed to the troubleshooting forums..." to match existing
docs terminology.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9d17d8fe-316e-4201-aa65-e086cf7a4650
📒 Files selected for processing (1)
source/administration-guide/configure/site-configuration-settings.rst
|
Newest code from mattermost has been published to preview environment for Git SHA d1c2e7c |
|
@vish9812 - Can you help rebase to the 11.7 documentation branch when you're able? Thanks so much in advance! |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
source/administration-guide/configure/site-configuration-settings.rst (1)
256-256: Consider clarifying the "open a support case by email" mechanism.The phrase "can open a support case by email with the Mattermost support team" could be more specific about what actually happens when a licensed user selects Report a Problem. Based on the PR description mentioning "open an email," it appears an email client opens automatically. Consider revising to be more explicit:
Suggested clarification
-- **Default**: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_. +- **Default**: Licensed Mattermost deployments open an email in the user's default email client addressed to Mattermost support. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_.This helps Novice Nate (a novice IT admin) understand exactly what users will experience when they select this option.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/administration-guide/configure/site-configuration-settings.rst` at line 256, Update the Default description sentence that currently reads "can open a support case by email by email with the Mattermost support team" to explicitly describe the user experience when a licensed user selects "Report a Problem" (e.g., that it opens the user's default email client with a prepopulated message addressed to Mattermost support). Locate the sentence containing the "Default" text and the phrase "Report a Problem"/"open a support case by email" and replace it with a clearer line that states the email client will open and what fields (recipient/subject/body) are prefilled or that the user is taken to an email compose window to send to Mattermost support.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@source/administration-guide/configure/site-configuration-settings.rst`:
- Line 256: Update the Default description sentence that currently reads "can
open a support case by email by email with the Mattermost support team" to
explicitly describe the user experience when a licensed user selects "Report a
Problem" (e.g., that it opens the user's default email client with a
prepopulated message addressed to Mattermost support). Locate the sentence
containing the "Default" text and the phrase "Report a Problem"/"open a support
case by email" and replace it with a clearer line that states the email client
will open and what fields (recipient/subject/body) are prefilled or that the
user is taken to an email compose window to send to Mattermost support.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 49af6177-5b0d-44c4-805d-5f97268c5e57
📒 Files selected for processing (1)
source/administration-guide/configure/site-configuration-settings.rst
There was a problem hiding this comment.
Pull request overview
Updates Mattermost documentation for the Report a Problem setting to reflect new default behavior and corrects a related environment variable typo.
Changes:
- Update the “Default” behavior description for Report a Problem for licensed vs. unlicensed deployments.
- Fix environment variable name typo for
ReportAProblemMail.
| With self-hosted deployments, you can specify how the **Report a Problem** option behaves in the Mattermost app via the **Help** menu: | ||
|
|
||
| - **Default link**: Uses the default Mattermost URL to report a problem. Customers with a Mattermost subscription are directed to the `Mattermost Support Portal <https://support.mattermost.com/hc/en-us/requests/new>`_. Community deployments are directed to `create a new issue on the Mattermost GitHub repository <https://github.com/mattermost/mattermost/issues/new>`_. | ||
| - **Default**: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_. |
There was a problem hiding this comment.
(Editor Evie, Friction) In the type list, the label changed from Default link to Default. Unless the System Console option label also changed, this makes the docs harder to match/search against the UI. Also, “open a support case by email” is a bit ambiguous—consider wording that explicitly says it opens the user’s default email client/composer to contact Mattermost Support (and that unlicensed deployments are directed to the troubleshooting forums).
| - **Default**: Customers with a Mattermost license can open a support case by email with the Mattermost support team. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_. | |
| - **Default link**: Customers with a Mattermost license can open their default email client or composer to contact Mattermost Support. Unlicensed Mattermost deployments are directed to the `troubleshooting forums <https://mattermost.com/pl/report_a_problem_unlicensed>`_. |
|
Newest code from mattermost has been published to preview environment for Git SHA 9999eb3 |
@vish9812 The server PR hasn't been merged yet so we don't yet know which release this will go into. For now we can keep the "Do not Merge" label and update the milestone after the server PR has been merged. |
Summary
MM_SUPPORTSETTINGS_REPORTAPROBLMEMAIL→MM_SUPPORTSETTINGS_REPORTAPROBLEMMAILWeb PR: mattermost/mattermost#35900
Mobile PR: mattermost/mattermost-mobile#9703
Test plan
🤖 Generated with Claude Code