-
Notifications
You must be signed in to change notification settings - Fork 608
Draft: Rework Calls Deployment Guide #8879
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 23 commits
9fa3794
9a2ed57
0d96b59
4835b64
89a8386
4da4a85
a298cbd
be54c5a
855e76e
3ebb08a
62030ec
beabac2
fb0154b
67c50de
aacd90f
ce98172
8a5caef
360f42a
ea585a9
8f72dd8
12d2864
fe36000
2f420ba
c6d90dc
0b53f3f
123e2ec
42fae25
3e209ae
f3e9de7
820d2b2
83791ad
7b5e793
e669e17
06952dd
57116d4
9476157
ca625e7
3990143
cb7888a
84a1c5c
44c378f
4aa7aaf
89ff2ac
483cea6
5d733f2
6fbaee9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Large diffs are not rendered by default.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -482,7 +482,7 @@ Max call participants | |||||
| .. note:: | ||||||
| - This setting is applicable only to self-hosted deployments. | ||||||
| - The environment variable ``MM_CALLS_MAX_PARTICIPANTS`` is deprecated in favor of ``MM_CALLS_MAX_CALL_PARTICIPANTS``. | ||||||
| - This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. See the :doc:`Calls self-hosted deployment </administration-guide/configure/calls-deployment>` documentation for details. | ||||||
| - This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. See the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for details. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix the grammar in the participant-limit note. “Limits” is plural, so “depends” should be “depend”. Suggested edit- - This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. See the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for details.
+ - This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits depend greatly on instance resources. See the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for details.As per coding guidelines, “Flag awkward phrasing, punctuation mistakes, tense shifts, and terminology inconsistencies in documentation.” 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
|
|
||||||
|
|
||||||
| .. config:setting:: ice-servers-configurations | ||||||
|
|
@@ -510,7 +510,7 @@ ICE servers configurations | |||||
| - The configurations above, containing STUN and TURN servers, are sent to the clients and used to generate local candidates. | ||||||
| - If hosting calls through the plugin (i.e. not using the |rtcd_service|) any configured STUN server may also be used to find the instance's public IP when none is provided through the |ice_host_override_link| option. | ||||||
|
|
||||||
| .. |rtcd_service| replace:: :doc:`RTCD service </administration-guide/configure/calls-deployment>` | ||||||
| .. |rtcd_service| replace:: :doc:`RTCD service </administration-guide/configure/calls-deployment-guide>` | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Point the This replacement is used in configuration notes specifically about the standalone Suggested fix-.. |rtcd_service| replace:: :doc:`RTCD service </administration-guide/configure/calls-deployment-guide>`
+.. |rtcd_service| replace:: :doc:`RTCD service </administration-guide/configure/calls-rtcd-setup>`As per coding guidelines, “When a docs link is broken, brittle, or non-standard, explain the issue briefly and provide the smallest correct replacement.” 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| **Example** | ||||||
|
|
||||||
|
|
@@ -758,7 +758,7 @@ Call recording quality | |||||
|
|
||||||
| .. note:: | ||||||
| - This setting is applicable only to self-hosted deployments. | ||||||
| - The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :ref:`deployment section <administration-guide/configure/calls-deployment:call recording and transcription>` for more information. | ||||||
| - The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for more information. | ||||||
|
|
||||||
| .. config:setting:: enable-pluginscalltranscriptions | ||||||
| :displayname: Enable call transcriptions (Plugins - Calls) | ||||||
|
|
@@ -810,7 +810,7 @@ Transcriber model size | |||||
|
|
||||||
| .. note:: | ||||||
| - This setting is applicable only to self-hosted deployments. | ||||||
| - This setting is available starting in plugin version 0.22. The model size setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions <administration-guide/configure/calls-deployment:call recording and transcription>` documentation for more information. | ||||||
| - This setting is available starting in plugin version 0.22. The model size setting will affect the performance of the job service. Refer to the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for more information. | ||||||
|
|
||||||
| .. config:setting:: call-transcriber-threads | ||||||
| :displayname: Call transcriber threads (Plugins - Calls) | ||||||
|
|
@@ -834,7 +834,7 @@ Call transcriber threads | |||||
|
|
||||||
| .. note:: | ||||||
| - This setting is applicable only to self-hosted deployments. | ||||||
| - The call transcriber threads setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions <administration-guide/configure/calls-deployment:call recording and transcription>` documentation for more information. This setting is available starting in plugin version 0.26.2. | ||||||
| - The call transcriber threads setting will affect the performance of the job service. Refer to the :doc:`Calls deployment guide </administration-guide/configure/calls-deployment-guide>` documentation for more information. This setting is available starting in plugin version 0.26.2. | ||||||
|
|
||||||
| .. config:setting:: enable-pluginslivecaptions | ||||||
| :displayname: (Experimental) Enable live captions (Plugins - Calls) | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use a security-focused callout for full-log sharing guidance.
Line 31 currently tells users to provide the complete logs, but this can expose sensitive data (tokens, internal hostnames, user identifiers, IPs). This should be a warning (not a note) and include a short sanitization/secure-sharing instruction.
Suggested minimal diff
Verify each finding against the current code and only fix it if needed.
In
@source/administration-guide/configure/calls-logging.mdaround lines 30 - 32,The current documentation callout uses a benign note and instructs users to
"provide the complete set of logs", which can leak secrets; change the callout
token from {note} to {warning} and update the message in the RTCD/client logs
block to instruct users to only share logs via approved support channels and to
sanitize/remove secrets, tokens, internal hostnames, IPs and user-identifying
data before sharing — locate and edit the fenced block that begins with
{note} (the RTCD/client logs paragraph) to use{warning} and append theshort secure-sharing/sanitization guidance.