Desktop v6.1.0: Add Sentry error reporting documentation #8723
Merged
cwarnermm merged 5 commits intodesktop-v6.1-documentationfrom Feb 9, 2026
Merged
Desktop v6.1.0: Add Sentry error reporting documentation #8723cwarnermm merged 5 commits intodesktop-v6.1-documentationfrom
cwarnermm merged 5 commits intodesktop-v6.1-documentationfrom
Conversation
Add comprehensive documentation for the new Sentry error reporting feature introduced in Mattermost Desktop v6.1.0 across all relevant personas: End User documentation: - Updated customize-desktop-app-experience.rst to document the new "Send error reports to help improve the app" setting in Advanced section - Added details about what data is collected, privacy protections, and restart requirement System Admin documentation: - Updated desktop-app-deployment.rst with Privacy and data handling section - Documented default behavior, data collection details, and organizational considerations for admins - Added guidance for organizations with restrictive data policies Risk Assessor documentation: - Created new desktop-app-privacy.rst with comprehensive privacy and compliance information - Documented data collection scope, PII exclusions, and technical controls - Included compliance considerations for GDPR, data residency, and consent - Added audit and verification guidance Troubleshooting: - Updated desktop-troubleshooting.rst with error reporting context - Added step-by-step instructions to disable error reporting - Documented what data is and isn't collected Related to mattermost/desktop#3610 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA b06e3da |
devinbinnie
reviewed
Feb 9, 2026
Member
devinbinnie
left a comment
devinbinnie
left a comment
There was a problem hiding this comment.
We make a lot of comments on the nature of what Sentry is and what it does. Do we do the same for the server? If not - I'd recommend cutting down a fair bit on what we're adding here.
|
|
||
| 1. **Communicate with users**: Inform users about this default-enabled feature and provide guidance on whether to disable it based on your organization's data handling policies | ||
| 2. **User control**: Users can disable error reporting at any time through the desktop app Settings. The setting requires an app restart to take effect | ||
| 3. **Build-time control**: Organizations building the desktop app from source can prevent Sentry initialization entirely by omitting the ``MM_DESKTOP_BUILD_SENTRYDSN`` environment variable during the build process |
Member
There was a problem hiding this comment.
This only matters if they're custom building the app. This likely wouldn't apply to most customers using the app we've built. I'd say we could remove this, or we move it to wherever we mention custom build options.
Member
There was a problem hiding this comment.
@claude Remove point 3 and other reference to the build flags. The one place in the privacy docs that I commented on seems like the right place to call this out.
Contributor
There was a problem hiding this comment.
Claude finished @devinbinnie's task in 59s —— View job
Tasks
- Read deployment and privacy documentation files
- Identify point 3 and other build flag references to remove
- Remove build flag references from deployment docs
- Commit and push changes
Summary
Removed point 3 and the build flag reference (MM_DESKTOP_BUILD_SENTRYDSN) from the deployment documentation as requested. The organizational considerations section now has 3 points instead of 4, with the build-time control information remaining only in the privacy documentation where it's more appropriately detailed.
Changes made:
- Removed point 3 about build-time control from
desktop-app-deployment.rst - Renumbered remaining point (former point 4 is now point 3)
- Build flag documentation remains in
desktop-app-privacy.rstlines 103-107
Commit: d89cff2
| Technical implementation details | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| **Build-time configuration**: |
Member
There was a problem hiding this comment.
Is this stuff relevant here?
| - Provide step-by-step instructions to disable error reporting via **Settings > Advanced** | ||
| - Remind users that a restart is required after changing the setting | ||
|
|
||
| 2. **Consider custom builds**: |
Member
There was a problem hiding this comment.
This seems like the right place to talk about this.
| - App version and platform information (OS type, architecture, memory stats) | ||
| - Stack traces and error messages | ||
|
|
||
| Error reports do **not** include: |
Member
There was a problem hiding this comment.
Do we need to repeat ourselves here?
Member
There was a problem hiding this comment.
@claude Remove this section from this file - it's not relevant here.
Contributor
There was a problem hiding this comment.
Claude finished @devinbinnie's task in 2m 6s —— View job
Tasks
- Read troubleshooting file to identify section to remove
- Remove the "Error reporting" section from troubleshooting.rst
- Commit changes locally
- Push changes to remote (blocked - needs git fetch approval)
Completed
I've successfully removed the "Error reporting" section from source/deployment-guide/desktop/desktop-troubleshooting.rst. The section (lines 4-33) has been deleted and committed locally with commit hash bd90fca.
Unable to Complete Push
The push is blocked because there are concurrent changes on the remote branch that I need to integrate first. The git fetch and git pull commands require approval in my current permission set.
What happened: Another Claude instance appears to be working on your other review comment (removing build flags from deployment docs) on the same branch simultaneously. This created a conflict where the remote has commits I don't have locally.
Resolution options:
- Grant approval for
git fetchandgit pullcommands so I can sync and complete the push - Wait for the other Claude task to complete, then retry (the remote state should stabilize)
- Manually pull and push the changes yourself
The code change itself is complete and correct - it's just the push that's blocked by the concurrent work.
Contributor
There was a problem hiding this comment.
Claude finished @devinbinnie's task in 54s —— View job
Tasks
- Check current repository state
- Sync with remote changes
- Verify and remove error reporting section
- Push changes to remote
Summary
Successfully removed the "Error reporting" section from source/deployment-guide/desktop/desktop-troubleshooting.rst. The section (lines 4-33) has been deleted and the changes have been committed and pushed to the remote branch.
Changes made:
- Removed the entire "Error reporting" section including all documentation about Sentry error reporting, what's included/excluded, and opt-out instructions
- The file now starts directly with the "Where is configuration stored locally?" section
Commit: 892841e
Per review feedback, removed point 3 about build-time control with MM_DESKTOP_BUILD_SENTRYDSN from deployment docs. This information is more appropriately detailed in the desktop-app-privacy.rst file. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com>
devinbinnie
reviewed
Feb 9, 2026
| @@ -0,0 +1,224 @@ | |||
| Desktop App Privacy and Data Handling | |||
Member
There was a problem hiding this comment.
@claude Remove this new page. Put all relevant information into desktop-app-deployment with the other changes.
Focus only on what information is sent and what isn't set. Briefly acknowledge privacy.
Don't talk about Sentrys or our inner workings. Keep it simple and brief.
Contributor
There was a problem hiding this comment.
Claude finished @devinbinnie's task in 1m 13s —— View job
Tasks
- Read current privacy and deployment documentation files
- Consolidate relevant information into deployment guide (brief, focused)
- Remove desktop-app-privacy.rst file
- Commit and push changes
Summary
Removed the separate desktop-app-privacy.rst file and consolidated the relevant information into desktop-app-deployment.rst with a simpler, more focused approach.
Changes made:
- Simplified the "Privacy and data handling" section in the deployment guide
- Focused on what information is and is NOT sent
- Removed detailed discussions about Sentry, compliance frameworks, and internal implementation
- Kept brief mention of build-time control for organizations building from source
- Deleted the 224-line privacy file entirely
New content structure:
- What information is sent: crash info, app version, platform details
- What is NOT sent: messages, credentials, PII, server URLs
- Brief privacy note about default-enabled status and user control
- Simple guidance for organizations with data policies
Commit: f81510a
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA d89cff2 |
Remove separate desktop-app-privacy.rst and consolidate relevant information into desktop-app-deployment.rst with simplified, focused content on what data is/isn't sent. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com>
Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com>
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA f81510a |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 892841e |
devinbinnie
approved these changes
Feb 9, 2026
Contributor
Author
|
Thanks, @devinbinnie, for your help streamlining the AI-first docs updates. |
cwarnermm
added
3: Reviews Complete
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA f347968 |
amyblais
added a commit
that referenced
this pull request
Mar 2, 2026
* Desktop v6.1.0: Add Sentry error reporting documentation (#8723) * Docs: Add Sentry error reporting documentation for Desktop v6.1.0 Add comprehensive documentation for the new Sentry error reporting feature introduced in Mattermost Desktop v6.1.0 across all relevant personas: End User documentation: - Updated customize-desktop-app-experience.rst to document the new "Send error reports to help improve the app" setting in Advanced section - Added details about what data is collected, privacy protections, and restart requirement System Admin documentation: - Updated desktop-app-deployment.rst with Privacy and data handling section - Documented default behavior, data collection details, and organizational considerations for admins - Added guidance for organizations with restrictive data policies Risk Assessor documentation: - Created new desktop-app-privacy.rst with comprehensive privacy and compliance information - Documented data collection scope, PII exclusions, and technical controls - Included compliance considerations for GDPR, data residency, and consent - Added audit and verification guidance Troubleshooting: - Updated desktop-troubleshooting.rst with error reporting context - Added step-by-step instructions to disable error reporting - Documented what data is and isn't collected Related to mattermost/desktop#3610 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> * Remove build flag references from deployment docs Per review feedback, removed point 3 about build-time control with MM_DESKTOP_BUILD_SENTRYDSN from deployment docs. This information is more appropriately detailed in the desktop-app-privacy.rst file. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Consolidate privacy docs into deployment guide Remove separate desktop-app-privacy.rst and consolidate relevant information into desktop-app-deployment.rst with simplified, focused content on what data is/isn't sent. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Remove error reporting section from troubleshooting docs Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Editorial reviews --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Desktop v6.1 docs: Add Flatpak to linux packaged builds (#8718) * Docs: Add Flatpak support for Mattermost Desktop v6.1.0 - Add new Flatpak tab to Linux desktop installation guide with detailed installation instructions for x86_64 and aarch64 architectures - Document Flatpak runtime requirements (Freedesktop Platform/SDK 25.08, Electron BaseApp 25.08) in software requirements - Add Flatpak availability note to desktop app deployment guide - Mark Flatpak as beta per release evidence - Include considerations for sandboxed environment and Wayland support Addresses issue #8716 Co-authored-by: Combs7th <Combs7th@users.noreply.github.com> * Apply suggestion from @devinbinnie Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> * Editorial updates --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <Combs7th@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> * Desktop v6.1 docs: Remove Icon element from shortcuts, default to base EXE for icon in shortcuts (#8719) * docs: Document Desktop v6.1.0 Windows MSI shortcut handling changes Update documentation across End User, System Admin, and IT Operations guides to reflect the Windows MSI installer shortcut handling changes introduced in Desktop v6.1.0. Changes include: - End User: Added upgrade notes and shortcut recreation steps - System Admin: Added deployment planning and Windows distribution context - IT Operations: Added troubleshooting guidance and rollout planning Related to mattermost/desktop#3648 Co-authored-by: Combs7th <Combs7th@users.noreply.github.com> * Update source/end-user-guide/access/install-desktop-app.rst Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> * docs: Streamline Desktop v6.1.0 shortcut documentation Reduce repetitive taskbar shortcut recreation guidance across documentation files. Detailed technical background will be covered in the changelog. Changes: - End user guide: Remove lengthy explanations, keep essential steps - MSI installer guide: Brief deployment planning consideration only - Troubleshooting: Concise symptom/scope/solution format - Desktop deployment: Clarify Windows Store recommendation Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> * docs: Clarify Windows Store deployment uses InTune for organizations Updated Windows Store option to specify that organizations deploy through InTune for centralized management, replacing outdated SCCM/Windows Store for Business reference. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove repetitive distribution options from MSI guide, clarify InTune deployment - Removed 'Windows distribution options' section from MSI installer guide - Content was duplicated from desktop-app-deployment.rst - Clarified that Windows Store for organizations deploys through InTune - Kept MSI-specific upgrade note in MSI guide Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove repetitive v6.1.0 upgrade content from end-user guide All detail about the Windows MSI shortcut issue is already covered in the troubleshooting section. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove repetitive v6.1.0 upgrade content from MSI guide Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Revert changes to all files except troubleshooting.rst Remove v6.1.0 upgrade documentation from end-user guide, MSI installer guide, and deployment guide. Keep only the troubleshooting entry as the single source of truth for the Windows MSI shortcut issue. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Revert whitespace-only changes to keep only troubleshooting.rst content Reverted trailing whitespace removal and newline additions from three files to ensure only the v6.1.0 troubleshooting section remains as the change. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Editorial reviews * Editorial updates --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <Combs7th@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Desktop v6.1.0: Document per-machine MSI installation changes (#8724) * Docs: Document Desktop v6.1.0 per-machine MSI installation changes From Mattermost Desktop v6.1.0, the Windows MSI installer defaults to per-machine (system-wide) installation to meet enterprise compliance requirements. This changes installation behavior and upgrade paths. Updates include: - End-user upgrade guidance with two distinct scenarios (<v5.9 and v5.9-v6.0.4) - System admin deployment considerations and support planning - Troubleshooting for v6.1.0 upgrade issues - System requirements noting admin privileges requirement Key changes documented: - New default install location: C:\Program Files\Mattermost - Registry keys now in HKLM instead of HKCU - Shortcuts in Public folder for all users - Manual uninstall required for v5.9-v6.0.4 per-user installs before upgrading Addresses issue #8722 Relates to desktop PR mattermost/desktop#3659 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> * Remove AI-generated content sections from deployment guide Remove Standardization benefits, Risk assessment, and Compliance verification sections as they contain repetitive AI-generated content that doesn't provide additional value. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Clarify GitHub release download instructions Specify to expand the Assets dropdown and download 'Source code (zip)' Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Remove 32-bit references from desktop MSI installer documentation Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Remove obsolete note about ALLUSERS parameter from v6.1.0 section Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Remove repetitive v6.1.0 upgrade instructions from install guide Removed the detailed 'Upgrade to v6.1.0 (Windows MSI)' section from the end-user installation guide as this information is already documented in the troubleshooting guide. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Simplify v6.1.0 deployment considerations section Reduced verbose content to essential 2 paragraphs covering: - Per-machine installation default for enterprise compliance - Technical details (Program Files location, HKLM registry, admin privileges) - Link to troubleshooting guide for v5.9-v6.0.4 upgrade path Removed AI-generated content including deployment templates, risk assessments, and support readiness sections that were repetitive. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Add bookmark anchor to troubleshooting guide link Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Fix troubleshooting guide link with bookmark anchor Use direct HTML anchor link format instead of :ref: directive to properly link to the upgrade troubleshooting section. Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Editorial reviews --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * Desktop v6.1.0: remove auto-updates, EXE installer (#8732) * docs: Update Desktop v6.1.0 - remove auto-updates, EXE installer Complete documentation updates for Mattermost Desktop v6.1.0 that removes automatic updates and replaces them with in-app notifications, and discontinues the Windows EXE installer in favor of MSI only. Changes: - Updated end-user installation guide with manual update workflows - Documented new in-app notification system for all platforms - Rewrote silent Windows distribution guide (removed EXE, MSI-only) - Updated MSI/GPO guide for notification-only behavior - Added troubleshooting sections for update notifications - Updated deprecated features to reflect completed transition - Added platform-specific manual update instructions Fixes #8725 Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> * docs: Remove unnecessary v6.1.0 update mechanism notice Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove ALLUSERS and DISABLEAUTOUPDATE parameters note Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove Windows EXE installer important note from silent distribution guide Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove v6.1.0 deprecation text from MSI/GPO guide - Remove v6.1.0 reference from Update Notifications table description - Remove entire 'Update Mechanism Change in v6.1.0' important block Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove ALLUSERS and DISABLEAUTOUPDATE parameters from silent install guide Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Fix menu path for manual update check Change 'Settings > Updates > Check Now' to 'Settings > General > Check for Updates Now' Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Simplify update check troubleshooting to not reference specific JSON file Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove v6.1.0 update mechanism important block from install guide Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> * docs: Remove 'Version already installed' troubleshooting item Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com> Co-authored-by: Devin Binnie <devinbinnie@users.noreply.github.com> Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> Co-authored-by: Combs7th <147677911+Combs7th@users.noreply.github.com> Co-authored-by: Combs7th <Combs7th@users.noreply.github.com> Co-authored-by: Devin Binnie <52460000+devinbinnie@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive documentation for the new Sentry error reporting feature introduced in Mattermost Desktop v6.1.0. This PR addresses documentation needs across three key personas:
Changes
customize-desktop-app-experience.rstto document the new Advanced settingdesktop-troubleshooting.rstwith error reporting context and opt-out instructionsdesktop-app-deployment.rstwith privacy/data handling section for adminsdesktop-app-privacy.rstwith comprehensive compliance documentationRelated
Generated with Claude Code