[MM-67856] docs: add /mobile-logs slash command#8913
[MM-67856] docs: add /mobile-logs slash command#8913
Conversation
Document the new /mobile-logs command introduced in mattermost/mattermost#35658, which toggles the attach_app_logs preference to enable attaching mobile app logs as a file in the Mattermost mobile client (v2.38+) for debugging. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughDocumentation added a Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
source/integrations-guide/built-in-slash-commands.rst (3)
73-75: Consider elevating this note toimportantseverity.This block documents permission constraints (non-admin limitations), security behaviour (username enumeration protection), and audit logging requirements. According to the coding guidelines, content describing "prerequisites, constraints, or high-impact information that materially affects correctness, supportability, compliance, or success" should use the
importantadmonition rather thannote.⚡ Suggested admonition change
-.. note:: +.. important:: Non-admin users can only manage their own preference. Attempts to target another account return a neutral *Unable to change mobile log settings for that user* message to avoid username enumeration. Preference changes made through this command are recorded in the audit log.As per coding guidelines, "Use
importantadmonition for prerequisites, constraints, or high-impact information that materially affects correctness, supportability, compliance, or success."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/built-in-slash-commands.rst` around lines 73 - 75, The current admonition uses ".. note::" to describe permission constraints, security behavior, and audit logging; change this to an ".. important::" admonition so the content is elevated per guidelines. Locate the block that begins with ".. note::" and the paragraph "Non-admin users can only manage their own preference..." and replace the directive with ".. important::" leaving the body text unchanged so the elevated severity correctly signals prerequisites/constraints, username enumeration protection, and audit logging requirements.
75-75: Consider consistent formatting for the error message text.The error message uses italics (
*...*), which is valid but differs from typical documentation patterns for UI text or system messages. Consider using quotation marks alone or quotation marks with bold for consistency with how UI labels are typically formatted.✍️ Alternative formatting options
Option 1: Plain quoted text
-Attempts to target another account return a neutral *Unable to change mobile log settings for that user* message to avoid username enumeration. +Attempts to target another account return a neutral "Unable to change mobile log settings for that user" message to avoid username enumeration.Option 2: Bold text (if treating as UI element)
-Attempts to target another account return a neutral *Unable to change mobile log settings for that user* message to avoid username enumeration. +Attempts to target another account return a neutral **Unable to change mobile log settings for that user** message to avoid username enumeration.As per coding guidelines, "Use bold for UI labels and short lead-ins."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/built-in-slash-commands.rst` at line 75, The sentence uses Markdown/RST italics markup for the error message (*Unable to change mobile log settings for that user*); update the formatting to follow the guideline (use bold for UI labels/short messages) by replacing the italics with bold markup (e.g., **Unable to change mobile log settings for that user**) or, if preferred, plain quoted text ("Unable to change mobile log settings for that user"); locate the exact message text and change the surrounding markup accordingly in the built-in slash command documentation entry.
62-62: Consider clarifying "to the message being sent" for precision.The phrase "attach their mobile app logs as a file to the message being sent" could be more precise. The definite article "the" suggests a specific message, but the feature applies to any message the user sends.
Consider rewording for clarity:
✍️ Suggested rewording
-Use ``/mobile-logs`` to enable an attachment option in the Mattermost mobile client that lets users attach their mobile app logs as a file to the message being sent. This helps administrators and support engineers debug mobile-specific issues by providing device-side context that isn't available from server logs alone. The command updates the ``attach_app_logs`` advanced preference and always responds with an ephemeral message visible only to the invoking user. +Use ``/mobile-logs`` to enable an attachment option in the Mattermost mobile client that lets users attach their mobile app logs as a file when sending messages. This helps administrators and support engineers debug mobile-specific issues by providing device-side context that isn't available from server logs alone. The command updates the ``attach_app_logs`` advanced preference and always responds with an ephemeral message visible only to the invoking user.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/built-in-slash-commands.rst` at line 62, Reword the sentence describing the /mobile-logs command to remove the ambiguous "the message being sent" and clarify that it enables an attachment option for any message the user sends; update the text around the command name ``/mobile-logs`` and the preference ``attach_app_logs`` to read something like "lets users attach their mobile app logs as a file to any message they send" and keep the rest of the description (advanced preference update and ephemeral response) intact.
🤖 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/integrations-guide/built-in-slash-commands.rst`:
- Around line 73-75: The current admonition uses ".. note::" to describe
permission constraints, security behavior, and audit logging; change this to an
".. important::" admonition so the content is elevated per guidelines. Locate
the block that begins with ".. note::" and the paragraph "Non-admin users can
only manage their own preference..." and replace the directive with "..
important::" leaving the body text unchanged so the elevated severity correctly
signals prerequisites/constraints, username enumeration protection, and audit
logging requirements.
- Line 75: The sentence uses Markdown/RST italics markup for the error message
(*Unable to change mobile log settings for that user*); update the formatting to
follow the guideline (use bold for UI labels/short messages) by replacing the
italics with bold markup (e.g., **Unable to change mobile log settings for that
user**) or, if preferred, plain quoted text ("Unable to change mobile log
settings for that user"); locate the exact message text and change the
surrounding markup accordingly in the built-in slash command documentation
entry.
- Line 62: Reword the sentence describing the /mobile-logs command to remove the
ambiguous "the message being sent" and clarify that it enables an attachment
option for any message the user sends; update the text around the command name
``/mobile-logs`` and the preference ``attach_app_logs`` to read something like
"lets users attach their mobile app logs as a file to any message they send" and
keep the rest of the description (advanced preference update and ephemeral
response) intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e686e2c6-9094-400a-a548-95524e760450
📒 Files selected for processing (1)
source/integrations-guide/built-in-slash-commands.rst
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the new built-in /mobile-logs slash command, which toggles attaching mobile app logs to messages for debugging in the Mattermost mobile app.
Changes:
- Documented the
/mobile-logscommand purpose and behavior. - Added usage examples for
on,off, andstatus(including admin targeting). - Noted minimum supported mobile app version and non-admin behavior.
|
Newest code from mattermost has been published to preview environment for Git SHA 9b0c077 |
1 similar comment
|
Newest code from mattermost has been published to preview environment for Git SHA 9b0c077 |
- Elevate security/audit note to .. important:: - Use bold instead of italics for the error message - Clarify the attachment applies to any message the user sends Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Newest code from mattermost has been published to preview environment for Git SHA 1bb1663 |
Summary
Document the new /mobile-logs command introduced in mattermost/mattermost#35658, which toggles the attach_app_logs preference to enable attaching mobile app logs as a file in the Mattermost mobile client (v2.38+) for debugging.
Ticket Link
MM-67856