Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[MM-57874] Calls: Live captions docs #7102

Closed
wants to merge 12 commits into from
Closed

[MM-57874] Calls: Live captions docs #7102

wants to merge 12 commits into from

Conversation

cpoile
Copy link
Member

@cpoile cpoile commented Apr 24, 2024

Summary

  • Docs for the live captioning functionality, and a new setting for the calls transcriber, all added in calls v0.26.2

Ticket Link

@cpoile cpoile changed the title live captions docs [MM-57874] Calls: Live captions docs Apr 24, 2024
@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 924cb89

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 109ca66

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 2573d3d

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA ca2c40a

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 3971c05

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 3037712

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 18d8b28

@cpoile cpoile added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels Apr 24, 2024
cwarnermm
cwarnermm approved these changes Apr 25, 2024
View reviewed changes
source/configure/calls-deployment.rst Outdated
@@ -4,7 +4,7 @@ Calls self-hosted deployment
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and also provides the deployment guidelines for the recording and transcription service.
This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and provides the deployment guidelines for the recording, transcription, and live captions service.

- `Terminology <#terminology>`__
Copy link
Member

Choose a reason for hiding this comment

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

These links are no longer needed since all section headings are displayed in the right pane on the docs site. I recommend removing to reduce maintenance overhead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @cwarnermm -- which link are you referring to?

Copy link
Member

Choose a reason for hiding this comment

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

Apologies for the ambiguity -- I'm referring to the mid-page links at the top of the document (the mini-TOC). It's not necessary anymore due to the new presentation layer we're using for the docs site.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, done, thanks Carrie.

@cwarnermm cwarnermm removed the 2: Editor Review Requires review by an editor label Apr 25, 2024
@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA bc7317e

@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA e564bcf

@github-actions GitHub Actions
Copy link

Newest code from cpoile has been published to preview environment for Git SHA 71ac99e

streamer45
streamer45 approved these changes Apr 30, 2024
View reviewed changes
Copy link
Contributor

@streamer45 streamer45 left a comment

Choose a reason for hiding this comment

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

Looks good!

source/configure/plugins-configuration-settings.rst
| - **true**: Enables live captioning of calls. | - System Config path: **Plugins > Calls** |
| - **false**: **(Default)** Live captions functionality is disabled. | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.enablelivecaptions`` |
| | |
| Live captions are generated from the call participants' audio tracks and the resulting captions can be optionally displayed on the call clients by clicking the `[cc]` button. | |
Copy link
Contributor

Choose a reason for hiding this comment

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

Note to self: this will need updating once we ship the call settings as the button is moved to a menu item.

@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 4641879

@cwarnermm
Copy link
Member

@streamer45 - Has live captions been delivered in a previous Mattermost release? Wondering if this docs PR should be queued up with v9.8, or should be merged now.

@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Apr 30, 2024
@streamer45
Copy link
Contributor

@streamer45 - Has live captions been delivered in a previous Mattermost release? Wondering if this docs PR should be queued up with v9.8, or should be merged now.

@cwarnermm That's right, we are shipping the feature with MM v9.8

@cwarnermm cwarnermm added this to the v9.8.0 milestone Apr 30, 2024
@cwarnermm cwarnermm added the Do Not Merge/Awaiting Next Release To be merged with the next release (e.g. API documentation updates) label Apr 30, 2024
@cwarnermm cwarnermm changed the base branch from master to v9.8-documentation May 10, 2024 20:58
@cwarnermm cwarnermm removed the Do Not Merge/Awaiting Next Release To be merged with the next release (e.g. API documentation updates) label May 10, 2024
@cwarnermm cwarnermm changed the base branch from v9.8-documentation to master May 10, 2024 20:59
@cwarnermm
Copy link
Member

/update-branch

@mattermost-build
Copy link
Contributor

Error trying to update the PR.
Please do it manually.

@cwarnermm cwarnermm changed the base branch from master to v9.8-documentation May 10, 2024 21:00
cwarnermm added a commit that referenced this pull request May 13, 2024
@cwarnermm
Incorporated #7102 into v9.8
f8d8cf6
@cwarnermm cwarnermm mentioned this pull request May 13, 2024
Merged
@cwarnermm
Copy link
Member

Closing this PR in favour of #7120 (due to extensive merge conflicts).

@cwarnermm cwarnermm closed this May 13, 2024
cwarnermm added a commit that referenced this pull request May 13, 2024
@cwarnermm
Incorporated #7102 into v9.8 (#7120)
fced1cf
amyblais added a commit that referenced this pull request May 16, 2024
@amyblais @cwarnermm
@harshilsharma63 @marianunez
V9.8 Docs (#7079)
826c62c 
* Update conf.py

* Clarified that 1000 guidance is for 100-1000 concurrent users (#7112)

* Added 5M message limit (#7114)

* Added --local to example & updated formatting (#7115)

* Added Elasticsearch > Rebuild channels index option for admins (#7116)

* Added 2 new Amazon S3 upload/export part size config settings (#7125)

* Added Amazon S3 upload/export part size config settings

* second config setting

* Incorporated reviewer feedback

* User is notified if @mention isn't part of team (#7118)

* Aligned docs with updated user experience for notification preferences (#7119)

* Incorporated #7102 into v9.8 (#7120)

* Added Don't Clear DND option (#7121)

* Deprecated MaxIdleConns config setting (#7122)

* Clarified that roles & permissions schemes can be exported (#7123)

* Added new flags to mmctl import process (#7126)

* Updated section title to clarify action (#7128)

* Incorporates feature labels with existing content (#7129)

* Incorporates feature labels with existing content

* Final content iterations; removed duplication

* Removed Gfycat references (#7117)

* Removed Gfycat references

* Removed remaining gfycat references

* Added max payload size config setting (#7127)

* Added max payload size config setting

* Update source/configure/file-storage-configuration-settings.rst

Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>

* Incorporated reviewer feedback

* Table syntax fix

---------

Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>

* Code references to pgLoader corrected to pgloader (#7113)

* code references to pgLoader corrected to pgloader

* Converted remaining instances of pgLoader to lowercase l

* Build warning/error fixes

* v9.8 changelog (#7082)

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update open-source-components.rst

* Update release-lifecycle.rst

* Update download-latest-tarball.rst

* Update important-upgrade-notes.rst

* Update prepare-to-upgrade-mattermost.rst

* Update extended-support-release.rst

* Update version-archive.rst

* Add files via upload

* Update extended-support-release.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update software-hardware-requirements.rst

* Apply suggestions from code review

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

---------

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>
Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwarnermm cwarnermm cwarnermm approved these changes

@streamer45 streamer45 streamer45 approved these changes

Assignees
No one assigned
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Milestone
v9.8.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@cpoile @cwarnermm @streamer45 @mattermost-build