Add documentation

benefits-us.rst

@@ -17,7 +17,7 @@ This overview is a quick reference guide and does not replace the documentation
 
 The Company covers health insurance up the following contribution caps: 
 
-**Insurance & Company Contribution Cap**
+**Insurance and Company Contribution Cap**
 
 - Medical Employee Only: $362.00
 - Medical Employee + Spouse: $797.00

source/administration/backup.rst

@@ -1,4 +1,4 @@
-Backup & Disaster Recovery 
+Backup and Disaster Recovery 
 ==========================
 
 Options to protect your Mattermost server from different types of failures range from simple backup to sophisticated disaster recovery deployments and automation. 

source/administration/bulk-export-data.rst

@@ -5,7 +5,7 @@ At this time, the export supports attributes of the objects listed below. All Ma
 You can export the following data types:
 
 - Teams
-- Channels (Public & Private)
+- Channels (Public and Private)
 - Users
 - Users' Team memberships
 - Users' Channel memberships

source/administration/bulk-export.rst

@@ -4,13 +4,17 @@
 Bulk Export Tool
 =================
 
-Data from one Mattermost instance into another can be exported in the `JSONL
-<http://jsonlines.org>`__ file using the `bulk loading feature <https://docs.mattermost.com/deployment/bulk-loading.html>`__. This tool is useful if you have created a server for a proof of concept, have created another server for production use and now want to retain the history from the proof of concept instance.
+Moving data from one Mattermost instance into another begins with exporting data
+to a `JSONL <http://jsonlines.org>`__ file using the
+`bulk loading feature <https://docs.mattermost.com/deployment/bulk-loading.html>`__.
+This tool is useful if you have created a server for a proof of concept, have
+created another server for production use and now want to retain the history
+from the proof of concept instance.
 
 You can export the following data types:
 
 - Teams
-- Channels (Public & Private)
+- Channels (Public and Private)
 - Users
 - Users' Team memberships
 - Users' Channel memberships

source/administration/config-settings.rst

@@ -4462,3 +4462,4 @@ The height to which profile pictures are resized after being uploaded via Accoun
 +----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | This feature's ``config.json`` setting is ``"ProfileHeight": 128`` with whole number input.                                                                          |
 +----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+

source/administration/telemetry.rst

@@ -73,7 +73,7 @@ Non-personally Identifiable Error Information, distinguished by end users and Sy
 Non-personally Identifiable Diagnostic Information, distinguished by end users and System Admins
   Boolean when the following events occur:
 
-  - *Team and Account Setup Diagnostics:* Account creation via email, invite or UI, account creation page view, account creation completion; tutorial step & tip completion or opt out, team creation page view, team name and URL entry, team creation completion
+  - *Team and Account Setup Diagnostics:* Account creation via email, invite or UI, account creation page view, account creation completion; tutorial step and tip completion or opt out, team creation page view, team name and URL entry, team creation completion
   - *Sign-in Diagnostics:* Login succeeded or failed for email, LDAP or SAML/SSO; logout succeeded; switched authentication method from email to LDAP or SAML/SSO or vice versa; reset password; updated password
   - *Navigation Discovery Diagnostics:* Joined a channel from the "More" list, through an invite or by clicking a public link; created a channel, direct, or group direct message conversation; renamed, joined, left or deleted an existing channel; updated header or purpose; added or removed members; updated channel notification preferences; loaded more messages in a channel; switched a channel or a team; opened the "More" modal for channels or direct message conversations; updated team name; invited members; updated account settings
   - *Core Feature Discovery Diagnostics:* Created, edited or deleted a message; posted a message containing a hashtag, link, mention or file attachment; searched for a term; searched for flagged posts or recent mentions

source/deployment/bulk-loading.rst

@@ -10,7 +10,7 @@ Large quantities of data can be imported from a `JSONL
 You can import the following data types:
 
 - Teams
-- Channels (Public & Private)
+- Channels (Public and Private)
 - Users
 - Users' Team memberships
 - Users' Channel memberships
@@ -33,4 +33,4 @@ Importing additional types of posts is not yet supported.
 
 .. include:: bulk-loading-about.rst
 .. include:: bulk-loading-data.rst
-.. include:: bulk-loading-data-format.rst
+.. include:: bulk-loading-data-format.rst

source/getting-started/implementation_plan.rst

@@ -184,7 +184,7 @@ Large quantities of data can be imported from a JSON file into Mattermost at the
 You can import the following data types:
 
  - Teams
- - Channels (Public & Private)
+ - Channels (Public and Private)
  - Users
  - Users’ Team memberships
  - Users’ Channel memberships
@@ -237,7 +237,7 @@ Train administrators on the tasks required to manage Mattermost.
 
 **Reference**: https://docs.mattermost.com/guides/administrator.html
 
-3.3.13 Update Legal & Support Settings
+3.3.13 Update Legal and Support Settings
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Mattermost has configuration settings for the terms of service, privacy policy, and support URLs and emails. It is highly recommended that you modify these in your configuration so that your users have the correct legal information and can contact administrators to resolve account issues. You can find these under **System Console > Legal and Support** in prior versions or **System Console** > **Site Configuration** > **Customization** in versions after 5.12.

source/guides/administrator.rst

@@ -40,6 +40,7 @@ Learn how to get Mattermost running on your environment.
    /install/deploy-cloudron*
    Installing Mattermost Team Edition in GitLab Helm Chart </install/install-mmte-helm-gitlab-helm.rst>
    /install/troubleshooting*
+   /install/trouble_mysql.rst
    /install/desktop*
    /install/desktop-msi-gpo*
    /install/smtp*

source/help/apps/desktop-changelog.rst

@@ -974,7 +974,7 @@ All platforms
 -  Should execute following command to take over ``config.json``.
 
    -  Windows:
-      ``mkdir %APPDATA%\Mattermost & copy %APPDATA%\electron-mattermost\config.json %APPDATA%\Mattermost\config.json``
+      ``mkdir %APPDATA%\Mattermost and copy %APPDATA%\electron-mattermost\config.json %APPDATA%\Mattermost\config.json``
    -  OS X:
       ``ditto ~/Library/Application\ Support/electron-mattermost/config.json ~/Library/Application\ Support/Mattermost/config.json``
    -  Linux:

source/help/getting-started/signing-in.rst

@@ -8,6 +8,11 @@ To sign in, navigate to the Mattermost sign-in page. You can get the URL of the
 After signing in, the team that appears first on your team sidebar will open.  If you have not joined a team, the Team Selection
 page opens where you can view a list of teams that you can join.
 
+.. contents::
+  :depth: 2
+  :local:
+  :backlinks: entry
+
 Sign In Methods
 ---------------
 
@@ -62,7 +67,7 @@ account using a one-click sign in option.
 
 AD/LDAP Sign In
 ~~~~~~~~~~~~~~~
-*Available in Enterprise Edition E10 & E20*
+*Available in Enterprise Edition E10 and E20*
 
 When enabled by your System Admin, you can sign in with your AD/LDAP
 credentials. This lets you use the same username and password for

source/help/messaging/formatting-text.rst

@@ -13,6 +13,7 @@ Open the emoji autocomplete by typing ``:`` followed by two characters of the wo
 Renders as:
 
 .. image:: ../../images/Emoji1.PNG
+   :alt: Sample Emoji
 
 Text Style
 ----------
@@ -26,8 +27,10 @@ You can use either ``_`` or ``*`` around a word to make it italic. Use two to ma
 
 .. |bold_italics| image:: ../../images/bold_italics.PNG
   :width: 100px
+  :alt: Bold Italics
 .. |strikethrough| image:: ../../images/strikethrough.PNG
   :width: 100px
+  :alt: Strike Through
 
 Links
 -----
@@ -52,6 +55,7 @@ Make a heading by typing # and a space before your title. For smaller headings,
 Renders as:
 
 .. image:: ../../images/Headings1.PNG
+   :alt: Large Heading
 
 Alternatively, you can underline the text using ``===`` or ``---`` to create headings.
 
@@ -63,6 +67,7 @@ Alternatively, you can underline the text using ``===`` or ``---`` to create hea
 Renders as:
 
 .. image:: ../../images/Headings2.PNG
+   :alt: Smaller Heading
 
 Lists
 -----
@@ -122,6 +127,7 @@ Make a task list by including square brackets:
 Renders as:
 
 .. image:: ../../images/checklist.PNG
+   :alt: List
 
 Code Block
 ----------
@@ -178,19 +184,22 @@ Renders as:
 **GitHub Theme**
 
 .. image:: ../../images/syntax-highlighting-github.PNG
+   :alt: Syntax Highlighting in GitHub
 
 **Solarized Dark Theme**
 
 .. image:: ../../images/syntax-highlighting-sol-dark.PNG
+   :alt: Syntax Highlighting Dark
 
 **Solarized Light Theme**
 
 .. image:: ../../images/syntax-highlighting-sol-light.PNG
+   :alt: Syntax Highlighting Light
 
 **Monokai Theme**
 
 .. image:: ../../images/syntax-highlighting-monokai.PNG
-
+   :alt: Syntax Highlighting Monokai
 
 In-line Code
 ------------
@@ -242,6 +251,7 @@ Inline image with link
   Renders as:
 
   .. image:: ../../images/icon-76x76.png
+     :alt: MatterMost Icon 76X76
     :alt: Mattermost
     :target: https://github.com/mattermost/mattermost-server
 
@@ -304,6 +314,7 @@ Create a table by placing a dashed line under the header row and separating the
 Renders as:
 
 .. image:: ../../images/markdownTable1.PNG
+   :alt: Markdown Table Sample
 
 
 Math Formulas
@@ -321,3 +332,4 @@ Create formulas by using LaTeX in a ``latex`` `Code Block`_
 Renders as:
 
 .. image:: ../../images/markdownMath.PNG
+   :alt: Markdown Math Sample

source/install/i18n.rst

@@ -1,9 +1,9 @@
 ..  _i18n:
 
-Chinese, Japanese & Korean Search
+Chinese, Japanese and Korean Search
 =================================
 
-Enabling search for Chinese, Japanese & Korean (CJK) requires special configuration, since these languages do not contain spaces. 
+Enabling search for Chinese, Japanese and Korean (CJK) requires special configuration, since these languages do not contain spaces. 
 
 - See `database requirements documentation <https://docs.mattermost.com/install/requirements.html#database-software>`__ for how to setup search for these languages. 
 

source/install/prod-windows-2012.rst

@@ -14,7 +14,7 @@ Install Windows Server 2012+
 ----------------------------
 
 1. Set up 3 machines with any edition of Windows Server 2012+ (except core) with 2GB of RAM or more. The
-   servers will be used for the Web Proxy & SSL Termination, Mattermost, and Database.  The screenshots 
+   servers will be used for the Web Proxy and SSL Termination, Mattermost, and Database.  The screenshots 
    used in this guide are from Microsoft Server 2012, but similar steps should work for other versions.
 
    -  **Optional:** You can also use a single machine for all 3
@@ -31,7 +31,7 @@ Set up Database Server
 1.  Login to the database server.  For the purposes of this guide we will assume this server has an IP
     address of 10.0.0.1.
 
-Install & Configure MySQL
+Install and Configure MySQL
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 2. `Download the MySQL 5.6+ <http://dev.mysql.com/downloads/windows/installer/>`__ installer, or (PostgreSQL 9.3+).

source/install/requirements.rst

@@ -1,6 +1,6 @@
 ..  _requirements:
 
-Software & Hardware Requirements
+Software and Hardware Requirements
 ================================
 
 This guide outlines minimum software and hardware requirements for deploying Mattermost. Requirements may vary based on utilization and observing performance of pilot projects is recommended prior to scale out.