Skip to content

docs: add Slack integration guide - #12438

Draft
pfe-nazaries wants to merge 1 commit into
feature/slack-disconnect-resiliencefrom
feature/slack-integration-docs
Draft

docs: add Slack integration guide#12438
pfe-nazaries wants to merge 1 commit into
feature/slack-disconnect-resiliencefrom
feature/slack-integration-docs

Conversation

@pfe-nazaries

Copy link
Copy Markdown
Contributor

Context

PR 4 of 4, the top of the Slack integration stack. Based on #12437 — review the layers below first; this PR's diff is the documentation page plus one link.

The page documents choosing a channel, sending a test message and disconnecting, so there was nothing to screenshot until the three layers below existed. It merges last for the same reason.

Description

  • New docs/user-guide/tutorials/prowler-app-slack-integration.mdx, mirroring the Jira tutorial in structure and voice, registered in docs/docs.json beside the other integration tutorials.
  • Covers, in order: what the integration does; where it is available; the install flow; choosing the default channel; sending a test message; disconnecting and what revocation means.
  • States which scopes are requested and why. chat:write.public reads broader on the consent screen than it behaves — Prowler only ever posts to the channel recorded on the integration — so the page says that plainly rather than leaving a reader to wonder. It also explains that a private channel appears only after @Prowler is invited to it in Slack, by that channel's own members: that invite is the permission grant, and no scope bypasses it.
  • One sentence disambiguating this from the CLI's existing --slack output, so the two are not conflated. The CLI feature is not documented here.
  • Resolves the placeholder "Learn more" link on the Slack card, which the first layer deliberately left pointing nowhere.

Steps to review

  1. Read the page as a user who has never seen the feature — the scopes section is the part most worth scrutiny, since it is what a security-minded reader will check before approving the app.
  2. Screenshots: six, all 1920x1080, under docs/images/prowler-app/slack/.
  3. On how the screenshots were produced: the API is not deployed anywhere reachable, so they could not be captured from a live environment. They are staged against the mock backend, driven by the same MSW handlers the tests use, with fixture data only — no real workspace, tenant, account or user appears in any of them. The OAuth callback screen is deliberately not captured, because its URL carries a live authorization code and state.
  4. The only code change is the card's href; the suite should be unchanged at 21 passing tests.

Checklist

Community Checklist
  • This feature/issue is listed in the roadmap
  • Is it assigned to me
  • Are there new checks included in this PR? No
  • Review if the code is being covered by tests.
  • Review if code is being documented — this PR is the documentation.
  • Review if backport is needed. No — new feature.
  • Review if is needed to change the Readme.md No.
  • Ensure a changelog fragment is added under <component>/changelog.d/ — included because the "Learn more" link is a user-visible UI change; a docs-only change would have taken the no-changelog label instead.

UI

  • All issue/task requirements work as expected on the UI
  • Screenshots/Video - Mobile (X < 640px) — not captured; the docs page is desktop-oriented.
  • Screenshots/Video - Tablet (640px > X < 1024px) — not captured.
  • Screenshots/Video - Desktop (X > 1024px) — six 1920x1080 captures included in the diff.
  • Ensure a changelog fragment is added under ui/changelog.d/

API

Not applicable — no API change in this PR, by design.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f5f8de8c-7bb1-4bc6-b04b-35c012c98e8d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

- Cover the install flow via Add to Slack, choosing the default channel,
  sending a test message, and what disconnecting revokes
- State the four bot scopes Prowler requests, that `chat:write.public`
  reads broader than it behaves, and that a private channel appears only
  once `@Prowler` is invited to it in Slack
- Point the Slack card's Learn more link at the new page
- Distinguish the integration from the Prowler CLI's `--slack` output
@pfe-nazaries
pfe-nazaries force-pushed the feature/slack-integration-docs branch from 07c69ea to 04ae3ca Compare August 13, 2026 12:34
@github-actions

Copy link
Copy Markdown
Contributor

✅ All required changelog fragments are present.

@github-actions

Copy link
Copy Markdown
Contributor

No Conflicts

No conflict markers, and the branch merges cleanly into its base.

@github-actions

Copy link
Copy Markdown
Contributor

🔒 Container Security Scan

Image: prowler-ui:12f4c97
Last scan: 2026-08-13 12:39:01 UTC

✅ No Vulnerabilities Detected

The container image passed all security checks. No known CVEs were found.

📋 Resources:

@github-actions

Copy link
Copy Markdown
Contributor

🔎 Container Security Scan (Grype)

Image: prowler-ui:12f4c97
Last scan: 2026-08-13 12:40:30 UTC

✅ Nothing Blocking

No findings at critical or high severity.


📋 Resources:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant