Skip to content

Update the MsCalendar plugin docs for clarity #8047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

abbas-dependable-naqvi
Copy link

@abbas-dependable-naqvi abbas-dependable-naqvi commented Jun 16, 2025

Summary

Update the MsCalendar plugin docs for clarity regarding the permissions for OAuth app.

@abbas-dependable-naqvi abbas-dependable-naqvi added the 1: Dev Review Requires review by a core commiter label Jun 16, 2025
Copy link

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

1 similar comment
Copy link

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

@cwarnermm
Copy link
Member

Hello @abbas-dependable-naqvi. Thank you for your documentation contribution. Please create a ticket with your proposed update against the Mattermost Google Plugin. Thanks!

@cwarnermm cwarnermm closed this Jun 16, 2025
@cwarnermm cwarnermm reopened this Jun 17, 2025
Copy link
Contributor

claude bot commented Jun 17, 2025

Claude finished @abbas-dependable-naqvi's task —— View job


PR Review Complete

Todo List:

  • Read and analyze modified documentation file
  • Check the added image file
  • Assess documentation quality and accuracy
  • Consider maintainer feedback about repository targeting
  • Provide comprehensive review feedback

Review Summary

This PR adds a helpful screenshot and documentation reference to clarify the final state of Azure OAuth permissions for the Microsoft Calendar integration.

Changes Analysis

Files Modified:

  • source/integrate/microsoft-calendar.rst: Lines 73-74 - Added image reference and alt text
  • source/images/ms-teams-meeting-permissions-final-state.png: New screenshot showing Azure permissions final state

Review Feedback

Positive Aspects

  • Improves User Experience: The added screenshot clearly shows what the final permissions configuration should look like in Azure, which will help users verify their setup
  • Proper Documentation Format: Correctly follows RST syntax and existing image reference patterns
  • Clear Alt Text: Descriptive alt text provided for accessibility
  • Visual Clarity: The screenshot shows all required permissions (Application and Delegated types) with their granted status

⚠️ Areas of Concern

  1. Repository Targeting Issue: The maintainer @cwarnermm correctly identified that this change may belong in the Mattermost Google Plugin repository rather than the docs repository. However, upon review:

    • The change is to microsoft-calendar.rst (not Google Calendar)
    • The documentation lives in this docs repository
    • The change enhances existing docs rather than plugin functionality
  2. Image Naming Inconsistency: The image is named ms-teams-meeting-permissions-final-state.png but relates to Calendar permissions, not Teams meetings specifically.

🔧 Recommendations

  1. Verify Repository: Double-check that this is the correct repository for this documentation update. The Microsoft Calendar plugin docs appear to live here, so this seems appropriate.

  2. Consider Image Rename: Consider renaming the image to ms-calendar-permissions-final-state.png for better consistency with the content.

  3. Integration Context: The added image at source/integrate/microsoft-calendar.rst:73-74 fits well contextually after the admin consent granting step.

Technical Assessment

  • Code Quality: N/A (documentation change)
  • Performance: No impact
  • Security: Screenshot shows appropriate OAuth permissions without exposing sensitive data
  • Test Coverage: N/A (documentation change)
  • Best Practices: Follows established RST documentation patterns

Verdict

The changes are technically sound and improve documentation clarity. The main concern is ensuring this is the appropriate repository for the change, but based on the file structure and content, this appears correct.

Recommendation: ✅ Approve with minor suggestions - The changes enhance user experience and follow proper documentation standards.


@cwarnermm
Copy link
Member

Please disregard my earlier comment about moving this content to its GitHub repository. I'm confusing this plugin with another one whose docs don't live on docs.mm.com. Apologies for my misunderstanding!

Copy link

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

@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Jun 17, 2025
Copy link

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

Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

@cwarnermm cwarnermm removed the 2: Editor Review Requires review by an editor label Jun 17, 2025
Copy link

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

Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1: Dev Review Requires review by a core commiter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants