Skip to content

Commit 00c70af

Browse files
amyblaisjasonblaisjustinegeffenadamjclarksonesethna
authored
V5.22 documentation (#3531)
* Update conf.py (#3452) * Update important-upgrade-notes.rst (#3476) * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst (#3464) * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst * Update important-upgrade-notes.rst (#3488) * Update open-source-components.rst (#3490) * Update open-source-components.rst * Update open-source-components.rst * Update telemetry docs for 5.22 (#3512) * Update config-settings.rst (#3506) * Update config-settings.rst Update for: mattermost/mattermost#13788. * Update source/administration/config-settings.rst * Updated with shortcut to open and close RHS * Updated with shortcut to open and close RHS * Updated with shortcut to react to last message * Updated with shortcut to react to last message (fixed table) * trying to escape backslash * Added Team switch shortcuts * Update mmctl-cli-tool.rst (#3513) Updated docs in line with: mattermost/mattermost#13986 * Update config-settings.rst (office365 update) (#3507) * Update config-settings.rst Added content for: mattermost/mattermost#13737. Formatting changes to Push Notifications section. Formatting change to heading (removed colon). * Update source/administration/config-settings.rst * ES v5.22 docs (#3501) * Add Team Sidebar GIF * Add Sidebar Phase 1 GIF * Adding team drag and drop * Add experimental channel sidebar features * sidebar experimental features * Update organizing-conversations.rst * Update source/administration/config-settings.rst Co-Authored-By: Amy Blais <[email protected]> * Update source/administration/config-settings.rst Co-Authored-By: Amy Blais <[email protected]> * Update source/administration/config-settings.rst Co-Authored-By: Amy Blais <[email protected]> * Update source/help/getting-started/organizing-conversations.rst Co-Authored-By: Amy Blais <[email protected]> * Delete sidebar-phase-1.gif * Update sidebar phase 1 GIF * Update config name to ExperimentalChannelSidebarOrganization * Update config-settings.rst Co-authored-by: Amy Blais <[email protected]> * Added UserMentions/ChannelMentions to example - Added ChannelMentions to the example payload - Added UserMentions to the example payload * Add docs to unarchive channels (resubmit) (#3511) * Add docs to unarchive channels * Add files via upload * Update organizing-conversations.rst General editorial review of doc; formatting and punctuation changes committed and minor rewording. * Update source/help/getting-started/organizing-conversations.rst Co-Authored-By: Justine Geffen <[email protected]> Co-authored-by: Justine Geffen <[email protected]> * Update config-settings.rst (#3517) * Update config-settings.rst OpenTracing docs * Fixed table rendering; rewording. * Update source/administration/config-settings.rst Co-authored-by: Justine Geffen <[email protected]> Co-authored-by: Justine Geffen <[email protected]> * Update config-settings.rst (experimental audit settings) (#3508) * Update config-settings.rst First draft of docs for mattermost/mattermost#14062 * Update config-settings.rst Added updated content as per feedback on mattermost/mattermost#14062 * Update config-settings.rst Formatting output examples. * Fixed bad formatting. * Update source/administration/config-settings.rst * Update source/administration/config-settings.rst * Update source/administration/config-settings.rst * Update source/administration/config-settings.rst * Update source/administration/config-settings.rst * Update source/administration/config-settings.rst * Removed "Experimental" from key names. * Removed "array" from string input for audit settings. * Formatting changes, included path. * Incorporated additional feedback and formatting. * Added default settings and general review/UI element formatting check. * Update source/administration/config-settings.rst Co-Authored-By: Amy Blais <[email protected]> * Update source/administration/config-settings.rst Co-Authored-By: Amy Blais <[email protected]> * Fixed rendering issue with Max size. * Added descriptions for audit: syslog and file configs. * Updated config settings as per discussion with @wiggins77. * Added three additional settings (syslog max queue size, file max queue size, syslog insecure). Co-authored-by: Amy Blais <[email protected]> * Update advanced-permissions.rst (#3496) * Update advanced-permissions.rst Added channel moderation section; initial steps. * Update advanced-permissions.rst Created example and updated content. * Update source/deployment/advanced-permissions.rst * Update source/deployment/advanced-permissions.rst * Update advanced-permissions.rst Removed steps in read-only channel recipes related to unchecking mentions. * Update source/deployment/advanced-permissions.rst * Update source/deployment/advanced-permissions.rst * Update source/deployment/advanced-permissions.rst * Update advanced-permissions.rst Removed section on public and private channels. * Update advanced-permissions.rst Added refined headings to differentiate channel and advanced permissions. * Update source/deployment/advanced-permissions.rst Co-Authored-By: Martin Kraft <[email protected]> * Update advanced-permissions.rst Updated description and removed reference to version prior to 5.12 for channel moderation. * Update advanced-permissions.rst Fixed numbering. * Update source/deployment/advanced-permissions.rst Co-Authored-By: Amy Blais <[email protected]> * Update advanced-permissions.rst Promote single member to channel admin update. Co-authored-by: Martin Kraft <[email protected]> Co-authored-by: Amy Blais <[email protected]> * v5.22 Changelog (#3451) * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update changelog.md * Update config-settings.rst (SMTP timeout) (#3515) * Update config-settings.rst Docs for: mattermost/mattermost#13251. * Update for mattermost/mattermost#13251. * Update for mattermost/mattermost#13251 * Update source/administration/config-settings.rst Co-Authored-By: Ibrahim Serdar Acikgoz <[email protected]> * Fixed table formatting. Co-authored-by: Ibrahim Serdar Acikgoz <[email protected]> Co-authored-by: Jason Blais <[email protected]> Co-authored-by: Justine Geffen <[email protected]> Co-authored-by: Adam Clarkson <[email protected]> Co-authored-by: Eric Sethna <[email protected]> Co-authored-by: Aaron Rothschild <[email protected]> Co-authored-by: Katie Wiersgalla <[email protected]> Co-authored-by: Justine Geffen <[email protected]> Co-authored-by: Martin Kraft <[email protected]> Co-authored-by: Ibrahim Serdar Acikgoz <[email protected]>
1 parent 334ae99 commit 00c70af

15 files changed

+654
-112
lines changed

‎source/administration/changelog.md‎

Lines changed: 129 additions & 0 deletions
Large diffs are not rendered by default.

‎source/administration/config-settings.rst‎

Lines changed: 223 additions & 52 deletions
Large diffs are not rendered by default.

‎source/administration/important-upgrade-notes.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ Important Upgrade Notes
77
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
88
| If you’re upgrading from a version earlier than... | Then... |
99
+====================================================+==================================================================================================================================================================+
10+
| v5.22.0 | Due to fixing performance issues related to emoji reactions, the performance of the upgrade has been affected in that the schema upgrade now takes more time in |
11+
| | environments with lots of reactions in their database. These environments are recommended to perform the schema migration during low usage times and potentially |
12+
| | in advance of the upgrade. Since this migration happens before the Mattermost Server is fully launched, non-High Availability installs will be unreachable |
13+
| | during this time. |
14+
| | |
15+
| | The migration is a single line of SQL and can be applied directly to the database through the MySQL/PSQL command line clients if you prefer to decouple this |
16+
| | from restarting the Mattermost server. It is fully backwards compatible so the schema change can be applied to any previous version of Mattermost without issue. |
17+
| | During the time the schema change is running (~30s per million rows in the Reactions table), if end users attempt to react to posts, the emoji reactions will |
18+
| | not load for end users. |
19+
| +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
20+
| | The Channel Moderation Settings feature is supported on mobile app versions v1.30 and later. In earlier versions of the mobile app, users who attempt to post or |
21+
| | react to posts without proper permissions will see an error. |
22+
| +------------------------------------------------------------------------------------------------------------------------------------------------------------------+
23+
| | Direct access to the ``Props`` field in the ``model.Post`` structure has been deprecated. The available ``GetProps()`` and ``SetProps()`` methods should now be |
24+
| | used. Also, direct copy of the ``model.Post`` structure must be avoided in favor of the provided ``Clone()`` method. |
25+
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1026
| v5.21.0 | Honour key value expiry in KVCompareAndSet, KVCompareAndDelete and KVList. We also improved handling of plugin key value race conditions and deleted keys in |
1127
| | Postgres. |
1228
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+

‎source/administration/mmctl-cli-tool.rst‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ the unit test coverage campaign for mmctl in the `Unit testing mmctl commands <h
4242
- `mmctl plugin`_ - Plugin Management
4343
- `mmctl post`_ - Post Management
4444
- `mmctl roles`_ - Roles Management
45+
- `mmctl system`_ - System Management
4546
- `mmctl team`_ - Team Management
4647
- `mmctl user`_ - User Management
4748
- `mmctl version`_ - Version Management
@@ -1921,6 +1922,132 @@ mmctl roles
19211922
19221923
This command will be available in a future release.
19231924
1925+
mmctl system
1926+
------------
1927+
1928+
System management commands for interacting with the server state and configuration.
1929+
1930+
Child Commands
1931+
- `mmctl system clearbusy`_ - Clears the busy state
1932+
- `mmctl system getbusy`_ - Get the current busy state
1933+
- `mmctl system setbusy`_ - Set the busy state to ``true``
1934+
1935+
**Options**
1936+
1937+
.. code-block:: sh
1938+
1939+
-h, --help help for system
1940+
1941+
**Options Inherited from Parent Commands**
1942+
1943+
.. code-block:: sh
1944+
1945+
--format string the format of the command output [plain, json] (default "plain")
1946+
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
1947+
--strict will only run commands if the mmctl version matches the server one
1948+
1949+
mmctl system clearbusy
1950+
^^^^^^^^^^^^^^^^
1951+
1952+
**Description**
1953+
1954+
Clear the busy state which re-enables non-critical services.
1955+
1956+
**Format**
1957+
1958+
.. code-block:: sh
1959+
1960+
mmctl system clearbusy [flags]
1961+
1962+
**Examples**
1963+
1964+
.. code-block:: sh
1965+
1966+
system clearbusy
1967+
1968+
**Options**
1969+
1970+
.. code-block:: sh
1971+
1972+
-h, --help help for clearbusy
1973+
1974+
**Options Inherited from Parent Commands**
1975+
1976+
.. code-block:: sh
1977+
1978+
--format string the format of the command output [plain, json] (default "plain")
1979+
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
1980+
--strict will only run commands if the mmctl version matches the server one
1981+
1982+
mmctl system getbusy
1983+
^^^^^^^^^^^^^^^^^^
1984+
1985+
**Description**
1986+
1987+
Gets the server busy state (high load) and timestamp corresponding to when the server busy flag will be automatically cleared.
1988+
1989+
**Format**
1990+
1991+
.. code-block:: sh
1992+
1993+
mmctl system getbusy [flags]
1994+
1995+
**Examples**
1996+
1997+
.. code-block:: sh
1998+
1999+
system getbusy
2000+
2001+
**Options**
2002+
2003+
.. code-block:: sh
2004+
2005+
-h, --help help for getbusy
2006+
2007+
**Options Inherited from Parent Commands**
2008+
2009+
.. code-block:: sh
2010+
2011+
--format string the format of the command output [plain, json] (default "plain")
2012+
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
2013+
--strict will only run commands if the mmctl version matches the server one
2014+
2015+
2016+
mmctl system setbusy
2017+
^^^^^^^^^^^^^^^^^^
2018+
2019+
**Description**
2020+
2021+
Set the busy state to ``true`` for the specified number of seconds, which disables non-critical services.
2022+
2023+
**Format**
2024+
2025+
.. code-block:: sh
2026+
2027+
mmctl system setbusy -s [seconds] [flags]
2028+
2029+
**Examples**
2030+
2031+
.. code-block:: sh
2032+
2033+
system setbusy -s 3600
2034+
2035+
**Options**
2036+
2037+
.. code-block:: sh
2038+
2039+
-h, --help help for setbusy
2040+
-s, --seconds uint Number of seconds until server is automatically marked as not busy. (default 3600)
2041+
2042+
**Options Inherited from Parent Commands**
2043+
2044+
.. code-block:: sh
2045+
2046+
--format string the format of the command output [plain, json] (default "plain")
2047+
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
2048+
--strict will only run commands if the mmctl version matches the server one
2049+
2050+
19242051
mmctl team
19252052
----------
19262053

‎source/administration/open-source-components.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Desktop
1616
Mobile
1717
------------------------------
1818

19+
- Mattermost Mobile v1.30.0 - `View Open Source Components <https://github.com/mattermost/mattermost-mobile/blob/release-1.30/NOTICE.txt>`_.
20+
- Mattermost Mobile v1.29.0 - `View Open Source Components <https://github.com/mattermost/mattermost-mobile/blob/release-1.29/NOTICE.txt>`_.
1921
- Mattermost Mobile v1.28.0 - `View Open Source Components <https://github.com/mattermost/mattermost-mobile/blob/release-1.28/NOTICE.txt>`_.
2022
- Mattermost Mobile v1.27.0 - `View Open Source Components <https://github.com/mattermost/mattermost-mobile/blob/release-1.27/NOTICE.txt>`_.
2123
- Mattermost Mobile v1.26.0 - `View Open Source Components <https://github.com/mattermost/mattermost-mobile/blob/release-1.26/NOTICE.txt>`_.
@@ -49,6 +51,8 @@ Mobile
4951
Redux
5052
------------------------------
5153

54+
- Mattermost Enterprise Edition v5.22.0 - `View Open Source Components <https://github.com/mattermost/mattermost-redux/blob/release-5.22/NOTICE.txt>`_.
55+
- Mattermost Enterprise Edition v5.21.0 - `View Open Source Components <https://github.com/mattermost/mattermost-redux/blob/release-5.21/NOTICE.txt>`_.
5256
- Mattermost Enterprise Edition v5.20.0 - `View Open Source Components <https://github.com/mattermost/mattermost-redux/blob/release-5.20/NOTICE.txt>`_.
5357
- Mattermost Enterprise Edition v5.19.0 - `View Open Source Components <https://github.com/mattermost/mattermost-redux/blob/release-5.19/NOTICE.txt>`_.
5458
- Mattermost Enterprise Edition v5.18.0 - `View Open Source Components <https://github.com/mattermost/mattermost-redux/blob/release-5.18/NOTICE.txt>`_.
@@ -75,6 +79,8 @@ Redux
7579
Server
7680
------------------------------
7781

82+
- Mattermost Enterprise Edition v5.22.0 - `View Open Source Components <https://github.com/mattermost/mattermost-server/blob/release-5.22/NOTICE.txt>`_.
83+
- Mattermost Enterprise Edition v5.21.0 - `View Open Source Components <https://github.com/mattermost/mattermost-server/blob/release-5.21/NOTICE.txt>`_.
7884
- Mattermost Enterprise Edition v5.20.0 - `View Open Source Components <https://github.com/mattermost/mattermost-server/blob/release-5.20/NOTICE.txt>`_.
7985
- Mattermost Enterprise Edition v5.19.0 - `View Open Source Components <https://github.com/mattermost/mattermost-server/blob/release-5.19/NOTICE.txt>`_.
8086
- Mattermost Enterprise Edition v5.18.0 - `View Open Source Components <https://github.com/mattermost/mattermost-server/blob/release-5.18/NOTICE.txt>`_.
@@ -121,6 +127,8 @@ Server
121127
Webapp
122128
------------------------------
123129

130+
- Mattermost Enterprise Edition v5.22.0 - `View Open Source Components <https://github.com/mattermost/mattermost-webapp/blob/release-5.22/NOTICE.txt>`_.
131+
- Mattermost Enterprise Edition v5.21.0 - `View Open Source Components <https://github.com/mattermost/mattermost-webapp/blob/release-5.21/NOTICE.txt>`_.
124132
- Mattermost Enterprise Edition v5.20.0 - `View Open Source Components <https://github.com/mattermost/mattermost-webapp/blob/release-5.20/NOTICE.txt>`_.
125133
- Mattermost Enterprise Edition v5.19.0 - `View Open Source Components <https://github.com/mattermost/mattermost-webapp/blob/release-5.19/NOTICE.txt>`_.
126134
- Mattermost Enterprise Edition v5.18.0 - `View Open Source Components <https://github.com/mattermost/mattermost-webapp/blob/release-5.18/NOTICE.txt>`_.

0 commit comments

Comments
 (0)