Refactor Mattermost Calls documentation into separate pages#7929
Refactor Mattermost Calls documentation into separate pages#7929bgardner8008 merged 65 commits intomattermost:masterfrom
Conversation
|
@streamer45 @cwarnermm - You can ignore this for the moment. I'm just trying to get it to publish a preview environment so i can look at how things lay out from the Claude Code changes. I'm not sure why I can't get this PR to build a preview |
|
Ah, I do, @sadohert. It's because it's a fork, not a branch. Only branches (via authorized users) trigger automated previews. For forks, we need to add the |
|
Newest code from sadohert has been published to preview environment for Git SHA d0ee389 |
|
@sadohert - Preview now available. |
|
Newest code from sadohert has been published to preview environment for Git SHA 0a722e5 |
|
Newest code from sadohert has been published to preview environment for Git SHA 39abca9 |
|
I'm transitioning these back to markdown. My bad. I thought RST was the standard we were moving to. I'll also resolve the merge conflict. |
a1d3830 to
304864a
Compare
|
Newest code from sadohert has been published to preview environment for Git SHA 304864a |
|
Newest code from sadohert has been published to preview environment for Git SHA 52cc483 |
|
TODOs:
|
|
Newest code from sadohert has been published to preview environment for Git SHA ae36560 |
|
Calls Deployment Overview: LGTM, though I note the section title doesn't match the index "Deploy Mattermost Calls". RTCD Setup and Configuration: "For detailed capability/credential configuration, reference the RTCD Service URL documentation." I think you could just remove this sentence as the rtcd-service-url section doesn't appear to exist. Calls Offloader Setup and Configuration: "Additionally, this override configuration is particularly useful if your Mattermost public Site URL uses HTTPS, because pointing the offloader directly to an internal HTTP endpoint bypasses the need to deal with client-side certificates." This is incorrect. Using http instead of https lets the offloader connect to the server without worrying about the server's TLS certificate. It has nothing to do with client side certs. You could simply state: "This override configuration lets the recorder and transcriber jobs connect to mattermost server using HTTP instead of HTTPS, which should only be used in a private network." Offloader Air-gapped installation There's a LOT of content devoted to setting up air-gapped deployment, which is all pretty moot given my script will do it all. And furthermore this section still references the older scripts which don't work correctly. I think we should just go all in on using the new script, it's 1000x easier. I will send you a .md file with complete rewrite for the "Air-Gapped Installation of calls-offloader" section. Calls Metrics and Monitoring: LGTM Kubernetes: Calls Deployment on Kubernetes The diagram shows RTCD running behind a load balancer. That's not actually correct as I've discussed earlier. If you have the ability to edit the image, the incorrect bit is the blue load-balancer icon in the RTCD cluster receiving connections from the mattermost cluster, please remove. If you can't edit the image, then just leave it. In the description of the image, remove item 2: "RTCD services are exposed through load balancers" In Kubernetes-Specific Configuration -> Network Configuration, remove item 3 "Load balancer configuration: Load balancers must be properly configured to handle UDP and TCP traffic routing to RTCD pods". In Scaling Considerations, Item 2 is incorrect and should be changed to: "DNS A records should be set up for all RTCD pods so server can discover RTCD servers." Item 3 should be: Health checks should ensure that only healthy pods are reported via DNS. Troubleshooting: LGTM |
- calls-offloader-setup: remove large sections of content per review - calls-kubernetes: remove inaccurate load balancer references, clarify DNS-based RTCD discovery - calls-deployment, calls-rtcd-setup: minor corrections Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
♻️ Duplicate comments (1)
source/administration-guide/configure/calls-kubernetes.md (1)
111-111:⚠️ Potential issue | 🔴 CriticalRemove the orphaned numbered list item.
Line 111 contains a stray "3." list item that doesn't belong in the "Other Calls Documentation" section. This same troubleshooting link already appears correctly in the bullet list at line 110. The orphaned item breaks the document structure.
🗑️ Proposed fix to remove the duplicate
- [Calls Metrics and Monitoring](calls-metrics-monitoring.md): Guide to monitoring Calls performance using metrics and observability - [Calls Troubleshooting](calls-troubleshooting.md): Detailed troubleshooting steps and debugging techniques -3. If you encounter issues, see [Calls Troubleshooting](calls-troubleshooting.md)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/administration-guide/configure/calls-kubernetes.md` at line 111, Remove the stray numbered list item "3. If you encounter issues, see [Calls Troubleshooting](calls-troubleshooting.md)" so the duplicate troubleshooting link is gone; locate the orphaned "3." entry in the "Other Calls Documentation" section and delete that single line (the correctly placed bullet at the previous line should remain unchanged).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@source/administration-guide/configure/calls-kubernetes.md`:
- Line 111: Remove the stray numbered list item "3. If you encounter issues, see
[Calls Troubleshooting](calls-troubleshooting.md)" so the duplicate
troubleshooting link is gone; locate the orphaned "3." entry in the "Other Calls
Documentation" section and delete that single line (the correctly placed bullet
at the previous line should remain unchanged).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c97b9271-d575-4b11-8500-7aad097cd62d
📒 Files selected for processing (4)
source/administration-guide/configure/calls-deployment.mdsource/administration-guide/configure/calls-kubernetes.mdsource/administration-guide/configure/calls-offloader-setup.mdsource/administration-guide/configure/calls-rtcd-setup.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Newest code from sadohert has been published to preview environment for Git SHA 5632854 |
|
When the air-gap-offloader documentation was imported, all the headings came in one level too high. So for example that section now appears as a separate chapter index in left hand navigation. You'll need to drop the headings down one level and it should be good. |
…ation Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Ah shoot, good catch @bgardner8008 ! A fix should be there now, and the one item from coderabbit. |
|
Newest code from sadohert has been published to preview environment for Git SHA ad52a65 |
Superseded by the calls-install-scripts repo approach documented in calls-offloader-setup.md. Script was unreferenced in the docs source. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bgardner8008
left a comment
There was a problem hiding this comment.
LGTM, let's go with this and if need be we can revisit minor details - it's too complicated now to continue commenting on this PR.
- calls-deployment: remove duplicate RHEL firewalld/fapolicyd section,
replace with a note linking to the section above; fix missing article
("UDP is the recommended protocol")
- calls-kubernetes: remove duplicate Calls Troubleshooting footer entry
- calls-rtcd-setup: add missing comma in bare metal deployment description
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@CodeRabbit resolve |
✅ Actions performedComments resolved and changes approved. |
Sub pages were added. Claude seemed to expand on the documentation for calls configuration, including deployment, metrics monitoring, RTC setup, and troubleshooting.
Summary by CodeRabbit