Skip to content

docs: Microsoft Teams (App) alert integration#2286

Open
MikaKerman wants to merge 3 commits into
masterfrom
teams-app-docs
Open

docs: Microsoft Teams (App) alert integration#2286
MikaKerman wants to merge 3 commits into
masterfrom
teams-app-docs

Conversation

@MikaKerman

@MikaKerman MikaKerman commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

For the docs team

Adds a new Cloud alert-integration page for the Microsoft Teams app (bot) integration — the new app-based Teams integration that replaces the legacy webhook integration.

What's here

  • New page: docs/cloud/integrations/alerts/ms-teams-app.mdx — titled "Microsoft Teams (App)".
  • Legacy page updated: docs/cloud/integrations/alerts/ms-teams.mdx — renamed to "Microsoft Teams (Legacy webhook)" with a deprecation warning pointing to the new app page.
  • Nav reordered in docs/mint.json — the new app page now appears before the legacy webhook page.
  • Screenshots — all included as local images under docs/images/teams/.

Page structure

  1. Hero — alert Adaptive Card screenshot showing a real alert in Teams.
  2. Connecting — simplified 3-step flow:
    • Install the Elementary app from the Microsoft Teams app store.
    • Click Connect to Elementary in the welcome card (connects automatically in Elementary).
    • Pick a default channel to start receiving alerts.
  3. Bot commands@Elementary help and @Elementary connect, each with a screenshot.
  4. Supported channels — standard channels only (not private/shared).
  5. Disconnecting — covers both directions (from Elementary UI and from Microsoft Teams).

Screenshots included

  • Hero alert card (Adaptive Card in Teams)
  • Welcome card ("Elementary has been added to this team!")
  • Connected dialog (Elementary UI)
  • Teams cards after successful connection
  • Messaging app connected state (Elementary UI)
  • @Elementary help response
  • @Elementary connect response

Changes from initial draft

  • Simplified from 5 connection steps to 3 — no unnecessary back-and-forth between Elementary and Teams.
  • Removed the requirement to start from Elementary's UI to get the app store link — users go directly to the Teams app store.
  • Every step clearly labels where the action happens (In Elementary / In Microsoft Teams).
  • All placeholder screenshot URLs replaced with real local images.
  • Legacy webhook page now has a deprecation warning.

Summary by CodeRabbit

  • New Features

    • Added documentation for the Microsoft Teams app integration, including setup, alert routing, bot commands, and disconnect steps.
    • Updated the integrations navigation to include the new Teams app guide.
  • Documentation

    • Clarified that the legacy Microsoft Teams webhook option is deprecated and directed new setups to the app-based integration.
    • Highlighted key setup details such as default channels, alert rules, and connection limits.

Documents the new Teams app (bot) messaging integration: install the Elementary
app in Teams, connect via the welcome card / @elementary connect, route alerts
to channels with alert rules, bot commands, supported channels, and disconnect
(remove the app in Teams). Mirrors the existing Slack / MS Teams (webhook) docs.

Screenshots are marked with placeholders (REPLACE_WITH_HOSTED_URL + a comment
describing each shot) for the docs team to drop in hosted images.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

👋 @MikaKerman
Thank you for raising your pull request.
Please make sure to add tests and document all user-facing changes.
You can do this by editing the docs files in this pull request.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4e969b6d-9538-4e17-b70d-4c76333ee166

📥 Commits

Reviewing files that changed from the base of the PR and between d1d5350 and bb8ae00.

⛔ Files ignored due to path filters (11)
  • docs/images/teams/alert-rule-teams.png is excluded by !**/*.png
  • docs/images/teams/connect-command.png is excluded by !**/*.png
  • docs/images/teams/connected-dialog.png is excluded by !**/*.png
  • docs/images/teams/connecting-dialog.png is excluded by !**/*.png
  • docs/images/teams/help-card.png is excluded by !**/*.png
  • docs/images/teams/hero-alert.png is excluded by !**/*.png
  • docs/images/teams/messaging-connected.png is excluded by !**/*.png
  • docs/images/teams/messaging-picker.png is excluded by !**/*.png
  • docs/images/teams/teams-cards-after-connection.png is excluded by !**/*.png
  • docs/images/teams/welcome-and-connected-cards.png is excluded by !**/*.png
  • docs/images/teams/welcome-card.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • docs/cloud/integrations/alerts/ms-teams-app.mdx
  • docs/cloud/integrations/alerts/ms-teams.mdx
  • docs/mint.json
✅ Files skipped from review due to trivial changes (3)
  • docs/mint.json
  • docs/cloud/integrations/alerts/ms-teams.mdx
  • docs/cloud/integrations/alerts/ms-teams-app.mdx

📝 Walkthrough

Walkthrough

A new Microsoft Teams App alert docs page was added with setup, routing, commands, supported channels, and disconnect behavior. The legacy Microsoft Teams webhook page was marked deprecated, and the docs navigation now includes the new page.

Changes

MS Teams Alert Documentation

Layer / File(s) Summary
Teams App integration page
docs/cloud/integrations/alerts/ms-teams-app.mdx
Adds the overview, connection flow, bot commands, supported channel types, and disconnection details for the Teams App integration.
Legacy webhook deprecation
docs/cloud/integrations/alerts/ms-teams.mdx
Renames the legacy Teams webhook page and replaces its intro with a deprecation warning that points to the Teams App page.
Navigation entry
docs/mint.json
Adds cloud/integrations/alerts/ms-teams-app to the Alerts & Incidents navigation list.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding the Microsoft Teams app alert integration docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch teams-app-docs

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/cloud/integrations/alerts/ms-teams-app.mdx`:
- Around line 14-19: The MS Teams app docs still contain placeholder image
sources in the screenshot frames, so replace every REPLACE_WITH_HOSTED_URL
reference with the real hosted asset URLs or remove the affected <Frame>/<img>
blocks until the screenshots are available. Update the repeated screenshot
sections in the MDX page consistently so the visible examples in the alert
walkthrough all render correctly before publishing.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2365a114-3dff-4a0b-8b00-a3c9f3ab266a

📥 Commits

Reviewing files that changed from the base of the PR and between 809127c and 49a1b46.

📒 Files selected for processing (2)
  • docs/cloud/integrations/alerts/ms-teams-app.mdx
  • docs/mint.json

Comment thread docs/cloud/integrations/alerts/ms-teams-app.mdx Outdated
MikaKerman and others added 2 commits June 30, 2026 14:48
The onboarding begins in Elementary (Connect messaging app → Microsoft
Teams), which deep-links into Teams to install the app — not from the
Teams store. Reorder the steps and screenshot placeholders to match.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add all screenshots for the Teams App integration docs page
- Simplify connection flow from 5 steps to 3 (install → connect → route)
- Label each step with where the action happens (Elementary vs Teams)
- Add deprecation warning to the legacy webhook page
- Reorder nav to list Teams App before legacy webhook

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant