fix(docs): update Zoom marketplace app creation steps#29758
Conversation
Align Zoom setup docs with the current General App flow (Development credentials, scopes, optional local install) so self-hosted users can connect Zoom without outdated marketplace steps. Fixes calcom#16193
|
Welcome to Cal.diy, @akshitj11! Thanks for opening this pull request. A few things to keep in mind:
A maintainer will review your PR soon. Thanks for contributing! |
📝 WalkthroughWalkthroughUpdated Zoom setup documentation in the README and docs site. The instructions now cover creating a development General App, configuring environment variables and OAuth redirect settings, enabling allow-list and subdomain checks, selecting 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@apps/docs/content/apps/zoom.mdx`:
- Around line 20-22: Update the environment-variable example in the Zoom
documentation to show valid .env assignments for ZOOM_CLIENT_ID and
ZOOM_CLIENT_SECRET, using non-sensitive placeholder values rather than bare
variable names.
In `@README.md`:
- Line 716: Update the self-hosted Cal.diy Zoom credential guidance to clarify
that Development-app credentials only work for users in the app owner’s Zoom
account unless external sharing is approved. Either narrow the instruction to
developer-account-only deployments or add the required Production activation and
app marketplace publishing path for external users.
🪄 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: e378e207-4f4a-45c7-b45d-100296afbb5e
📒 Files selected for processing (2)
README.mdapps/docs/content/apps/zoom.mdx
Address CodeRabbit feedback with valid .env placeholder assignments and note that Development credentials only cover the app owner's Zoom account.
|
Addressed CodeRabbit feedback ,updated .env placeholder format and clarified Development vs Production credential scope. |
There was a problem hiding this comment.
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 `@README.md`:
- Around line 718-721: Specify the fenced-block language for the Zoom
environment-variable example by adding dotenv (or bash) to the opening Markdown
fence, while leaving the ZOOM_CLIENT_ID and ZOOM_CLIENT_SECRET contents
unchanged.
🪄 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: cf3bac30-b453-484d-9a1d-92d62c29c6af
📒 Files selected for processing (2)
README.mdapps/docs/content/apps/zoom.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- apps/docs/content/apps/zoom.mdx
|
CodeRabbit fixes pushed. Please add the |
What does this PR do?
Zoom Marketplace updated the General App creation flow. The previous docs referenced an OAuth-only path, listed bare env var names without example values, and did not explain when Development vs Production credentials apply.
This PR updates the Zoom setup guide for the current marketplace UI and clarifies that Development credentials work for the app owner's Zoom account, with Production required for external users.
apps/docs/content/apps/zoom.mdxfor General App, Development credentials, scopes, and optional local install skipREADME.md.envplaceholder format and Development credential scopeVisual Demo (For contributors especially)
A visual demonstration is strongly recommended, for both the original and new change (video / image - any one).
Video Demo (if applicable):
Image Demo (if applicable):
apps/docs/content/apps/zoom.mdxagainst the Zoom Marketplace General App → Development credentials screen..envexample showsZOOM_CLIENT_ID=your_zoom_client_idstyle assignments.Mandatory Tasks (DO NOT REMOVE)
How should this be tested?
ZOOM_CLIENT_IDandZOOM_CLIENT_SECRET..envand Zoom connects from Settings → Conferencing apps for users on the app owner's Zoom account.apps/docs/content/apps/zoom.mdxand the README Zoom section.meeting:write:meeting,user:read:settings), and Development credential guidance match the live UI.