Skip to content

calls-deployment-v3#8851

Closed
esethna wants to merge 7 commits intomasterfrom
calls-deployment-v3
Closed

calls-deployment-v3#8851
esethna wants to merge 7 commits intomasterfrom
calls-deployment-v3

Conversation

@esethna
Copy link
Copy Markdown
Contributor

@esethna esethna commented Apr 2, 2026 •
edited
Loading

**Reorganizes calls-deployment.md as a comprehensive, phased deployment guide:

calls-deployment.md — Reorganization:

  • Restructured the document into a 4-phase lifecycle: Plan & Prepare → Deploy → Pilot Testing → Production Rollout
  • Added a top-level Table of Contents with section descriptions
  • Added a "How to Use This Guide" intro explaining the step numbering system and how to reference steps in support tickets
  • Phase 0 (Plan & Prepare): Added a Mermaid architecture diagram showing all components and ports; consolidated all infrastructure requirements into a single checklist; added a Decision Guide section walking admins through SFU mode, recording/transcription, and network traversal decisions with infrastructure implications for each
  • Phase 1 (Deploy): Combined Integrated and RTCD configuration into a single step with two explicit paths; added an optional calls-offloader deployment step with recording/transcription settings (correctly scoped to apply to both SFU paths); added a Verification Gate with pass/fail infrastructure and functional checks
  • Phase 2 (Pilot Testing): Added structured test scenarios for 1:1 calls, group calls, screen sharing, recording, live captions, cross-device (desktop ↔ mobile), remote/VPN, and long-duration calls; added a Monitor and Optimize section with healthy call indicators and expected-but-safe-to-ignore error patterns; added a Verification Gate
  • Phase 3 (Production Rollout): Added production configuration steps, an Incremental Rollout strategy using Test Mode, a draft user announcement post in Markdown, post-rollout monitoring guidance (metrics endpoints, Grafana dashboard ID 23225), and an explicit rollback plan
  • Appendix A: Troubleshooting organized by symptom with causes, fixes, and a diagnostic commands reference
  • Appendix B: Reference information (encryption, STUN, UDP vs. TCP, monitoring endpoints, documentation links)
  • Appendix C: RTCD and recording server sizing benchmarks; Linux kernel tuning parameters
  • Appendix D: Advanced network diagnostics for network teams (MTU path discovery, PMTUD, bandwidth testing)
  • Appendix E: Glossary (moved from inline content)
  • Embedded "Common Pitfall" callouts inline at the step where each pitfall occurs throughout all phases
  • All configuration settings presented in tables with Notes columns

calls-troubleshooting.md → calls-log-collection.md — Rename and refocus:

  • Renamed to better reflect the file's actual content (log collection, not symptom-based troubleshooting)
  • Updated title and introduction to explicitly scope the file to log gathering and link to the new calls-deployment.md appendix for symptom-based troubleshooting
  • Updated all references across calls-rtcd-setup.md, calls-offloader-setup.md, calls-metrics-monitoring.md, calls-kubernetes.md, and calls-overview.rst

Co-Authored-By: Claude Sonnet 4.6

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

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

@esethna esethna marked this pull request as ready for review April 2, 2026 23:46
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 2, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Documentation is restructured into a four-phase Mattermost Calls deployment framework with extensive appendices for troubleshooting, FAQs, and performance guidance. Navigation links across related documents are updated to reference a dedicated Log Collection page instead of a centralized Troubleshooting guide. Sphinx configuration enables the MyST tasklist extension.

Changes

Cohort / File(s) Summary
Deployment Guide Restructuring
source/administration-guide/configure/calls-deployment.md		 Comprehensive rewrite replacing overview+limitations structure with a four-phase deployment model (Phase 0: plan/prepare, Phase 1: deploy, Phase 2: pilot, Phase 3: production). Adds appendices covering symptom-based troubleshooting, FAQ, performance/sizing tables, and advanced network diagnostics. Includes infrastructure prerequisites, deployment decision workflows (SFU mode, recording/transcription, network traversal), verification gates, scenario-based test cases, and rollback options.
Documentation Navigation Updates
source/administration-guide/configure/calls-kubernetes.md, calls-log-collection.md, calls-metrics-monitoring.md, calls-offloader-setup.md, calls-overview.rst, calls-rtcd-setup.md		 Replaces "Calls Troubleshooting" reference with "Calls Log Collection" in documentation links. Kubernetes guide adds pointer to symptom-based troubleshooting via Deployment guide appendix. Log Collection page renamed from troubleshooting focus to log-gathering focus with reference to deployment guide for diagnostics.
Build Configuration
source/conf.py		 Adds "tasklist" MyST extension to myst_enable_extensions array for enhanced Markdown parsing capabilities.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'calls-deployment-v3' is vague and does not clearly convey the main changes, which include reorganization into a phased guide, document renaming, and configuration updates. Consider a more descriptive title such as 'Reorganize calls-deployment guide into phased lifecycle with log collection refocus' to better communicate the changeset's primary objectives.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description directly addresses the changeset, detailing the reorganization of calls-deployment.md into a phased guide and the renaming of calls-troubleshooting.md.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch calls-deployment-v3

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 and usage tips.

@esethna
Copy link
Copy Markdown
Contributor Author

esethna commented Apr 2, 2026

@adityadav1987 @bgardner8008 based on ongoing conversation regarding calls deploy docs, this doc restructures the deployment into a 4-phase lifecycle: Plan & Prepare → Deploy → Pilot Testing → Production Rollout with pre-reqs for each and key decision points built in.

I would appreciate technical review, general feedback and iteration as needed to get this to a state we are confident in.

@esethna
Copy link
Copy Markdown
Contributor Author

esethna commented Apr 3, 2026

@sadohert would also appreciate your feedback here given you recently reworked these docs.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

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

adityadav1987
adityadav1987 approved these changes Apr 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@adityadav1987 adityadav1987 left a comment

Choose a reason for hiding this comment

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

Looks fine

@esethna esethna added the Do Not Merge Should not be merged until this label is removed label Apr 3, 2026
@esethna esethna marked this pull request as draft April 3, 2026 19:22
@esethna esethna removed the request for review from bgardner8008 April 3, 2026 19:22
@esethna
Copy link
Copy Markdown
Contributor Author

esethna commented Apr 13, 2026

Superseded by #8879

@esethna esethna closed this Apr 13, 2026
@mattermost-build mattermost-build removed the Do Not Merge Should not be merged until this label is removed label Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

+1 more reviewer

@adityadav1987 adityadav1987 adityadav1987 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@esethna @adityadav1987 @mattermost-build