MM-67409 Added new zoom features to documentation#8763
MM-67409 Added new zoom features to documentation#8763avasconcelos114 merged 18 commits intomasterfrom
Conversation
…ation to specify subscription to recurring Zoom meetings The documentation was updated to clarify that the '/zoom subscribe [meeting ID]' command is used to subscribe a Mattermost channel to a recurring Zoom meeting. This change provides more accurate information to users, ensuring they understand the command's specific use case for recurring meetings.
…Mattermost channel to a Zoom meeting The documentation is updated to include an additional method of subscribing a Mattermost channel to a Zoom meeting. This provides users with more options and flexibility when setting up their meetings.
# Conflicts: # source/collaborate/chat-with-copilot.rst # source/integrations-guide/zoom.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 13864ee |
1 similar comment
|
Newest code from mattermost has been published to preview environment for Git SHA 13864ee |
| ------- | ||
|
|
||
| We recommend updating this integration when new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-zoom/releases>`__ for information on the latest release, previous releases, and compatibiilty considerations. |
There was a problem hiding this comment.
This message was present in the original PR so I've kept it as-is, not sure if we'd really like to keep it or not though
|
Newest code from mattermost has been published to preview environment for Git SHA 09224fa |
|
Thanks @avasconcelos114, who on the MM team can help review this for technical accuracy? |
|
@esethna Ah yes I was just able to confirm with @marianunez who would be good to have this assigned to Thanks for looking out 🙌 |
|
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 as they are similar to previous changes (1)
📝 WalkthroughWalkthroughZoom integration docs updated: Mattermost will receive Zoom cloud recordings and transcripts; OAuth scopes revised to non-admin meeting/recording/archive scopes; webhook subscription renamed and expanded to multiple events with verification; slash-command subscription management and Enable/Upgrade/Usage guidance clarified. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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 |
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
source/integrations-guide/zoom.rst (2)
99-154:⚠️ Potential issue | 🟠 MajorRemove duplicate "Upgrade" and "Get help" sections.
The documentation contains duplicate sections:
- "Upgrade" appears at lines 99-102 and again at lines 142-145
- "Get help" appears at lines 119-125 and again at lines 147-154
This creates confusion about which version is current. Based on the placement after the "Enable" section and the AI summary indicating these are new additions to the "Enable" section area, it appears lines 142-154 should be removed as they duplicate the newer content at lines 99-125.
🔧 Proposed fix to remove duplicate sections
Remove lines 142-154 entirely, keeping only the versions at lines 99-125 which follow the "Enable" section.
-Upgrade -------- - -We recommend updating this integration when new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-zoom/releases>`__ for information on the latest release, previous releases, and compatibiilty considerations. - -Get help --------- - -Mattermost customers can open a `Mattermost support case <https://support.mattermost.com/hc/en-us/requests/new>`_. To report a bug, please open a GitHub issue against the `Mattermost Zoom plugin repository <https://github.com/mattermost/mattermost-plugin-zoom>`_. - -For questions, feedback, and assistance, join our pubic `Integrations and Apps channel <https://community.mattermost.com/core/channels/integrations>`_ on the `Mattermost Community Server <https://community.mattermost.com/>`_ for assistance. - -Mattermost Team Edition and Free customers can visit the Mattermost `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`_ to access the global Mattermost Community for assistance.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/zoom.rst` around lines 99 - 154, The file contains duplicate "Upgrade" and "Get help" headings; remove the second occurrences that follow the "Enable" section (the later "Upgrade" and "Get help" blocks) and keep the first "Upgrade" and first "Get help" sections (the ones that appear immediately after "Enable"/the "Usage" block); simply delete the duplicate blocks so only one "Upgrade" heading and one "Get help" heading remain in the document.
152-152:⚠️ Potential issue | 🟡 MinorFix typo: "pubic" should be "public".
The word "pubic" should be "public" in the phrase "join our pubic Integrations and Apps channel".
Note: This line is within the duplicate "Get help" section that should be removed (as noted in a separate comment).
✏️ Proposed fix (if this section is retained)
-For questions, feedback, and assistance, join our pubic `Integrations and Apps channel <https://community.mattermost.com/core/channels/integrations>`_ on the `Mattermost Community Server <https://community.mattermost.com/>`_ for assistance. +For questions, feedback, and assistance, join our public `Integrations and Apps channel <https://community.mattermost.com/core/channels/integrations>`_ on the `Mattermost Community Server <https://community.mattermost.com/>`_ for assistance.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/zoom.rst` at line 152, Fix the typo by changing "pubic" to "public" in the sentence "join our pubic `Integrations and Apps channel <https://community.mattermost.com/core/channels/integrations>`_ on the `Mattermost Community Server <https://community.mattermost.com/>`_ for assistance."; update that exact string (the erroneous "pubic" token) to "public" and ensure there are no remaining occurrences of the same typo in the duplicate "Get help" section if you remove or retain that section per the other review comment.
🧹 Nitpick comments (2)
source/integrations-guide/zoom.rst (2)
40-40: Consider explaining why these scopes are required.The scopes list has been updated with recording and archiving permissions, but users may not understand what each scope enables. Adding a brief inline explanation would help admins make informed decisions about permissions. As per coding guidelines, explaining the 'why' behind settings reduces reader anxiety and increases confidence.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/zoom.rst` at line 40, Update the scopes list line to include a short parenthetical explanation for each Zoom scope so admins understand the purpose of each permission: e.g., explain that `meeting:read:meeting` allows retrieving meeting details, `meeting:write:meeting` allows creating/updating meetings, `user:read:user` allows reading user profile info, `cloud_recording:read:recording` enables access to cloud recording files, and `archiving:read:list_archived_files` allows listing archived files; place each explanation inline or as a comma-separated clause immediately after each quoted scope in the same sentence where the scopes are listed.
61-66: Consider adding a success verification step.After saving the webhook configuration, users have no way to verify the webhook is correctly configured before proceeding. As per coding guidelines, including expected output or a success check after key steps helps readers verify progress before continuing.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/integrations-guide/zoom.rst` around lines 61 - 66, After step 5 (Select Save) add a brief verification step instructing the user to confirm the webhook is active by sending a test event or using Zoom’s “Test Event” feature and verifying Mattermost returns a 200 OK (or the plugin logs a successful delivery), and instruct them to confirm the Secret Token shown in the UI matches the WEBHOOKSECRET used in the Event notification endpoint URL; reference the Event notification endpoint URL and Secret Token from steps 4–6 and describe the expected success indicator (HTTP 200 / “Validation successful” or a successful log entry) so readers can verify before proceeding.
🤖 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/integrations-guide/zoom.rst`:
- Line 97: Clarify that a "recurring Zoom meeting" is a Zoom meeting scheduled
to repeat on a regular basis (e.g., daily, weekly, or with no fixed time using
the "recurrence" option) and instruct the user to obtain the meeting ID from the
Zoom desktop/web client by opening the meeting's details (Meeting ID shown on
the meeting info page) or from the meeting invitation/email; then update the
/zoom subscription add [meeting ID] doc to briefly state these prerequisites and
where to find the Meeting ID so users know which ID to supply to the /zoom
subscription add [meeting ID] command.
- Line 115: Add a short prerequisite note instructing admins to enable Zoom
Cloud Recording and Audio Transcript in their paid Zoom account before using the
/zoom subscription add [meeting ID] command: sign in as an account admin, go to
Recording > Cloud Recording in the Zoom web portal to enable Cloud Recording and
enable Audio Transcript (or enable these settings at the user level and assign
recording permission to the meeting host), and refer to Zoom's official docs for
step-by-step guidance (see Zoom Cloud Recording documentation).
- Line 102: Typo: change the misspelled word "compatibiilty" to "compatibility"
in the sentence that references the Releases page link (the string containing
"Releases page <https://github.com/mattermost/mattermost-plugin-zoom/releases>"
and the following word "compatibiilty"). Locate that exact sentence in
source/integrations-guide/zoom.rst and replace "compatibiilty" with
"compatibility" so the sentence reads correctly.
- Line 8: The phrase "start both spontaneous video calls" is grammatically
incorrect; edit the sentence in the Zoom integration description (the line that
currently reads "Make it easy for your teams to start both spontaneous video
calls directly from Mattermost channels.") to remove the word "both" so it reads
"Make it easy for your teams to start spontaneous video calls directly from
Mattermost channels."
---
Outside diff comments:
In `@source/integrations-guide/zoom.rst`:
- Around line 99-154: The file contains duplicate "Upgrade" and "Get help"
headings; remove the second occurrences that follow the "Enable" section (the
later "Upgrade" and "Get help" blocks) and keep the first "Upgrade" and first
"Get help" sections (the ones that appear immediately after "Enable"/the "Usage"
block); simply delete the duplicate blocks so only one "Upgrade" heading and one
"Get help" heading remain in the document.
- Line 152: Fix the typo by changing "pubic" to "public" in the sentence "join
our pubic `Integrations and Apps channel
<https://community.mattermost.com/core/channels/integrations>`_ on the
`Mattermost Community Server <https://community.mattermost.com/>`_ for
assistance."; update that exact string (the erroneous "pubic" token) to "public"
and ensure there are no remaining occurrences of the same typo in the duplicate
"Get help" section if you remove or retain that section per the other review
comment.
---
Nitpick comments:
In `@source/integrations-guide/zoom.rst`:
- Line 40: Update the scopes list line to include a short parenthetical
explanation for each Zoom scope so admins understand the purpose of each
permission: e.g., explain that `meeting:read:meeting` allows retrieving meeting
details, `meeting:write:meeting` allows creating/updating meetings,
`user:read:user` allows reading user profile info,
`cloud_recording:read:recording` enables access to cloud recording files, and
`archiving:read:list_archived_files` allows listing archived files; place each
explanation inline or as a comma-separated clause immediately after each quoted
scope in the same sentence where the scopes are listed.
- Around line 61-66: After step 5 (Select Save) add a brief verification step
instructing the user to confirm the webhook is active by sending a test event or
using Zoom’s “Test Event” feature and verifying Mattermost returns a 200 OK (or
the plugin logs a successful delivery), and instruct them to confirm the Secret
Token shown in the UI matches the WEBHOOKSECRET used in the Event notification
endpoint URL; reference the Event notification endpoint URL and Secret Token
from steps 4–6 and describe the expected success indicator (HTTP 200 /
“Validation successful” or a successful log entry) so readers can verify before
proceeding.
🪄 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: 2e892679-7c88-4472-8ce0-d414b0840488
📒 Files selected for processing (1)
source/integrations-guide/zoom.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 8a8194d |
|
Newest code from mattermost has been published to preview environment for Git SHA 44ff5b0 |
|
Newest code from mattermost has been published to preview environment for Git SHA 2af63f5 |
|
Newest code from mattermost has been published to preview environment for Git SHA cb5e051 |
Summary
This PR adds the new scopes and other instructions related to the new features introduced in mattermost/mattermost-plugin-zoom#455
This PR also has a "sibling" PR that includes instructions related to the summarization feature that was added as well
This should not be merged before the PR above is both merged and released to a new version of the plugin
Ticket Link
Fixes https://mattermost.atlassian.net/browse/MM-67409