Skip to content

Commit 43a5fd2

Browse files
author
Justine Geffen
committed
Merge branch 'master' into justine-customer-portal
* master: Introduce Discord Dark themed Mattermost (#3567) Fix link to Cloudron demo (#3570) Update migrating.rst (#3571) Document plugin labels (#3548) Update migrating.rst (#3569) Update migrating.rst (#3559) Update myscript.js (#3566) Update upgrade.rst (#3562) Update custom-emoji.rst (#3564) Update changelog.md (#3561) Add reply arrow example (#3546) Update compliance.rst (#3555) Move release process docs to handbook (#3542)
2 parents 49723c0 + 2219d6c commit 43a5fd2

26 files changed

+82
-1271
lines changed

source/administration/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Also see [changelog in progress](http://bit.ly/2nK3cVf) for the next release.
88

99
- **v5.22.1, released 2020-04-23**
1010
- Fixed an issue where Amazon S3 file storage with IAM credentials failed due to a bug in the ``minio-go`` library. [MM-24388](https://mattermost.atlassian.net/browse/MM-24388)
11-
- **v5.22.0, released 2020-02-16**
11+
- **v5.22.0, released 2020-04-16**
1212
- Original 5.22.0 release
1313

1414
**Release day: 2020-04-16**

source/administration/compliance.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Enabling Compliance Reporting
2121

2222
After purchasing and installing a license key for Enterprise Edition E20:
2323

24-
1. Go to **System Console > Compliance > Compliance Monitoring** (or **System Console** > **General** > **Compliance** > **Enable Compliance** in versions prior to 5.12) and set the **Enable Compliance Reporting** value to ``true``.
24+
1. Go to **System Console > Compliance > Compliance Monitoring** (or **System Console > General > Compliance > Enable Compliance** in versions prior to 5.12) and set the **Enable Compliance Reporting** value to **true**.
2525
2. (Optional) In **Compliance Report Directory** specify the directory in which to place completed compliance reports. Defaults to ``./data/`` if left blank.
2626
3. Click **Save**.
2727

@@ -32,23 +32,23 @@ Turn on Daily Compliance Reports
3232

3333
After enabling compliance reporting:
3434

35-
1. Go to **System Console > Compliance > Compliance Monitoring** (or **System Console** > **General** > **Compliance** > **Enable Daily Report** in versions prior to 5.12) and set the **Enable Daily Report** value to ``true``.
35+
1. Go to **System Console > Compliance > Compliance Monitoring** (or **System Console > General > Compliance > Enable Daily Report** in versions prior to 5.12) and set the **Enable Daily Report** value to **true**.
3636
2. Click **Save**.
3737

38-
Your system will now export all new messages posted within a 24-hour period as a .csv file to the location specified in **Compliance Report Directory**. This feature can be used in conjunction with centralized compliance reporting systems that move.
38+
Your system will now export all new messages posted within a 24-hour period as a ``.csv`` file to the location specified in **Compliance Report Directory**. This feature can be used in conjunction with centralized compliance reporting systems that move.
3939

4040
Run Compliance Reports
4141
======================
4242

4343
Compliance Reports are exports of all messages in Mattermost that match the report criteria. To run a report:
4444

45-
1. Go to **System Console** > **Compliance Monitoring** (or **System Console > Compliance > Compliance Monitoring** in versions prior to 5.12).
45+
1. Go to **System Console > > Compliance > Compliance Monitoring** (or **System Console > Compliance > Compliance Monitoring** in versions prior to 5.12).
4646
2. Fill in the following criteria:
4747

48-
- **Job Name:** Name the compliance report you are about to run (e.g., "HR Audit 455").
49-
- **From:** Start Date for search in YYYY-MM-DD format (e.g., "2016-03-11").
50-
- **To:** End Date of search in YYYY-MM-DD format (e.g., "2016-05-11").
51-
- **Emails:** Comma separated list of email addresses of users whose posted messages you want to search (e.g., ``[email protected], [email protected]``).
48+
- **Job Name:** Name the compliance report you are about to run (e.g. "HR Audit 455").
49+
- **From:** Start Date for search in YYYY-MM-DD format (e.g. "2016-03-11").
50+
- **To:** End Date of search in YYYY-MM-DD format (e.g. "2016-05-11").
51+
- **Emails:** Comma-separated list of email addresses of users whose posted messages you want to search (e.g. ``[email protected], [email protected]``).
5252
- **Keywords:** Indicate the words that would be contained in a message for it to be included in the Compliance Report results.
5353
3. Click **Run Compliance Report**.
5454

@@ -62,7 +62,7 @@ The report will be queued in the display below the fields described above. The p
6262
- **Requested by:** Email of person requesting the report.
6363
- **Params:** Parameters of the compliance report request.
6464

65-
Each Compliance Report includes a **Download** link which downloads a compressed file named ``adhoc-[UNIQUE_ID].zip``. Inside the file is ``meta.json``, which includes the parameters of the search executed and ``posts.csv`` which includes the contents of messages found by the request.
65+
Each compliance report includes a **Download** link which downloads a compressed file named ``adhoc-[UNIQUE_ID].zip``. Inside the file is ``meta.json``, which includes the parameters of the search executed and ``posts.csv`` which includes the contents of messages found by the request.
6666

6767
Compliance query definition stored in ``meta.json`` file
6868
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

source/administration/migrating.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ Slack offers two ways to `export your data from their product <https://get.slack
110110

111111
2. You can request a "Corporate Export" from Slack directly to get a larger export including private channels, direct, and group messages.
112112

113-
Both exports from Slack use the same processes when importing into Mattermost.
114113

115114
.. note:: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by `filing an issue <https://www.mattermost.org/filing-issues/>`__.
116115

@@ -170,7 +169,7 @@ The following limitations are present when importing from Slack:
170169
Migrating from Slack using the Mattermost Web App
171170
`````````````````````````````````````````````````
172171

173-
.. note:: For larger imports, particularly those where you have used the `slack-advanced-exporter tool` to add Slack post attachments to the archive or the Corporate Export file, it is recommended to import the Slack data using the `CLI <https://docs.mattermost.com/administration/migrating.html#migrating-from-slack-using-the-mattermost-cli>`__.
172+
.. note:: For larger imports, particularly those where you have used the `slack-advanced-exporter tool` to add Slack post attachments to the archive or the Corporate Export file, it is recommended to import the Slack data using the `mmetl tool and bulk loading tool <https://docs.mattermost.com/administration/migrating.html#migrating-from-slack-using-the-mattermost-mmetl-tool-and-bulk-import>`__.
174173

175174
1. Generate a Slack export file from **Slack > Administration > Workspace Settings > Import/Export Data > Export > Start Export**. Alternatively, use the Slack Corporate Export file after receiving it from Slack.
176175

@@ -190,7 +189,16 @@ Migrating from Slack Using the Mattermost CLI
190189

191190
.. note:: To run the CLI command, you must be in the directory that contains the Mattermost installation. On a default installation of Mattermost, the directory is ``/opt/mattermost/``. Also, if you followed our `installation process <../guides/administrator.html#installing-mattermost>`__, you must run the command as the user *mattermost*. The executable is in the ``bin`` subdirectory and is called ``mattermost``.
192191

192+
Migrating from Slack Using the Mattermost mmetl Tool and Bulk Import
193+
`````````````````````````````````````````````````````````````````````
194+
.. note:: This method is the recommended way to import Slack's corporate export file.
193195

196+
1. Use the `slack-advanced-exporter <https://github.com/grundleborg/slack-advanced-exporter>`_ to download attachments and add users' email addresses to your Slack corporate export file.
197+
198+
2. Use the `mmetl tool <https://github.com/mattermost/mmetl>`_ to transform Slack's corporate export file into the ``jsonl`` format required by the bulk import tool.
199+
200+
3. Bulk load the files using the steps provided in the `bulk loading documentation <https://docs.mattermost.com/deployment/bulk-loading.html#bulk-loading-data>`_.
201+
194202
Using the Imported Team
195203
````````````````````````
196204

source/administration/plugins.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ The Plugin Marketplace is a collection of plugins that can greatly increase the
2020

2121
.. image:: https://user-images.githubusercontent.com/915956/66891467-1b18eb80-ef9e-11e9-9de3-37a3c5899bd8.png
2222

23+
Plugin Labels
24+
~~~~~~~~~~~~~~~~
25+
26+
Plugins in the Marketplace are labeled to make it easier for administrators to choose plugins that fit their company's security and risk policies if they do not allow for community plugins to be used.
27+
28+
**Community Plugins**
29+
30+
Plugins identified as "Community" are produced by the open-source community or partners and the features/roadmap are not controlled directly by Mattermost. Prior to being listed on the Plugin Marketplace, they are reviewed by the Mattermost development team and code-signed to ensure the code Mattermost reviewed, is delivered. Mattermost does not directly support these plugins in production environments.
31+
32+
**Beta Plugins**
33+
34+
Plugins may be labeled as "Beta" if they are released to the Plugin Marketplace early for customer previews. We do not recommend running Beta plugins on production servers.
35+
2336
Installing a plugin
2437
~~~~~~~~~~~~~~~~
2538

source/administration/upgrade.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Read these instructions carefully from start to finish. Make sure that you under
1616

1717
.. important::
1818
Review the :doc:`important-upgrade-notes` to make sure you are aware of any actions you need to take before or after upgrading from your particular version.
19+
20+
.. important::
21+
If you're upgrading from a version prior to v5.0 be sure to also modify your service file to work with the binary changes introduced with 5.0. Your execution directory should point to the Mattermost base directory (i.e. `/opt/mattermost`) and your binary should point to the `mattermost` binary (i.e. `/opt/mattermost/bin/mattermost`).
1922

2023
You should gather the following information before starting the upgrade:
2124

source/guides/core.rst

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,7 @@ Development Process
2626
Release Process
2727
-------------------
2828

29-
.. toctree::
30-
:maxdepth: 2
31-
:glob:
32-
33-
/process/release-faq*
34-
/process/feature-release*
35-
/process/bug-fix-release*
36-
/process/dot-release*
37-
/process/security-release*
38-
/process/mobile-release*
39-
/process/release-tips*
40-
/process/release-scorecard-definitions*
29+
This section has moved to the `Mattermost Handbook <https://handbook.mattermost.com/operations/research-and-development/product/release-process>`__.
4130

4231
Community Process
4332
-------------------

source/help/messaging/sending-messages.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ Write a message by typing into the text input box, then press ENTER to send it.
1313
Replying to Messages
1414
---------------------
1515

16-
Click the reply link (arrow icon that appears when hovering over a message) next to any message. This keeps conversations organized in threads. Replies are indented slightly in the center pane to indicate that they are child messages of a parent message.
16+
Hover over any message and click the reply link (arrow icon |replyarrow|). This organizes the conversation into a thread. Replies are indented slightly in the center pane to indicate that they are child messages of a parent message.
17+
18+
.. |replyarrow| image:: ../../images/replyIcon.PNG
19+
:alt: reply arrow
1720

1821
Clicking the reply link will open a sidebar on the right-hand side. To expand the right-hand sidebar to its full width, click the expand/shrink icon with two arrows at the top of the sidebar. To shrink the right-hand sidebar to its original width, click the same expand/shrink icon.
1922

source/help/settings/custom-emoji.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Custom Emoji
33
------------------
44

5+
**Note:** If you cannot see the **Custom Emoji** option in the menu, then your System Administrator may have restricted access to certain users. Contact your System Administrator for help.
6+
57
Settings for Custom Emoji are accessible from the **Main Menu** by clicking the hamburger menu at the top of the channels sidebar. Clicking **Custom Emoji** opens a page where you can view existing Custom Emojis and create new ones.
68

79
To create a Custom Emoji:
@@ -16,5 +18,3 @@ To create a Custom Emoji:
1618
Small, square pictures work best when selecting an image. The file can be any JPG, GIF, or PNG.
1719

1820
After saving, your emoji will show up in the list of Custom Emoji. To add your Custom Emoji to a message, simply type ":" followed by your emoji name to bring it up in the emoji autocomplete. Other users on the site will also be able to see your emoji in the autocomplete, and will be able to use it in their own messages.
19-
20-
Note: If you cannot see the **Custom Emoji** option in the menu, then your System Administrator may have restricted access to certain users. Contact your System Administrator for help.

source/help/settings/theme-colors.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,3 +149,14 @@ One Dark
149149
150150
{"sidebarBg":"#21252b","sidebarText":"#abb2bf","sidebarUnreadText":"#abb2bf","sidebarTextHoverBg":"#3a3f4b","sidebarTextActiveBorder":"#4d78cc","sidebarTextActiveColor":"#d7dae0","sidebarHeaderBg":"#282c34","sidebarHeaderTextColor":"#abb2bf","onlineIndicator":"#98c379","awayIndicator":"#d19a66","dndIndicator":"#be5046","mentionBj":"#98c379","mentionColor":"#ffffff","centerChannelBg":"#282c34","centerChannelColor":"#abb2bf","newMessageSeparator":"#c67add","linkColor":"#61afef","buttonBg":"#4d78cc","buttonColor":"#ffffff","errorTextColor":"#f44747","mentionHighlightBg":"#525a69","mentionHighlightLink":"#61afef","codeTheme":"monokai","mentionBg":"#98c379"}
151151
152+
Discord Dark Theme
153+
^^^^^^^^^^^^^^^^^^
154+
155+
.. image:: ../../images/discordDarkTheme.png
156+
:alt: Discord Dark Theme
157+
158+
`GitHub <https://github.com/danger89/mattermost-discord-dark>`_
159+
160+
.. code-block:: none
161+
162+
{"sidebarBg":"#2f3136","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#33363c","sidebarTextActiveBorder":"#66cfa0","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#27292c","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#43b581","awayIndicator":"#faa61a","dndIndicator":"#f04747","mentionBg":"#6e84d2","mentionBj":"#6e84d2","mentionColor":"#ffffff","centerChannelBg":"#36393f","centerChannelColor":"#dddddd","newMessageSeparator":"#6e84d2","linkColor":"#2095e8","buttonBg":"#43b581","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#3d414f","mentionHighlightLink":"#6e84d2","codeTheme":"monokai"}

source/images/discordDarkTheme.png

91.9 KB
Loading

0 commit comments

Comments
 (0)