diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/Setup.md | 26 | ||||
| -rw-r--r-- | doc/developer/tests/README.md | 18 | ||||
| -rw-r--r-- | doc/developer/tests/test-markdown-basics.md | 139 | ||||
| -rw-r--r-- | doc/developer/tests/test-markdown-lists.md | 177 | ||||
| -rw-r--r-- | doc/developer/tests/test-markdown.md | 25 | ||||
| -rw-r--r-- | doc/help/Notifications.md | 31 | ||||
| -rw-r--r-- | doc/help/README.md | 15 | ||||
| -rw-r--r-- | doc/install/Configuration-Settings.md | 13 | ||||
| -rw-r--r-- | doc/process/overview.md | 2 |
9 files changed, 399 insertions, 47 deletions
diff --git a/doc/developer/Setup.md b/doc/developer/Setup.md index 882aac530..24e7d6a90 100644 --- a/doc/developer/Setup.md +++ b/doc/developer/Setup.md @@ -11,7 +11,10 @@ Developer Machine Setup `docker-machine ip dev` 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` 4. Run `docker-machine env dev` and copy the export statements to your ~/.bash_profile -2. Download Go 1.5.1 from http://golang.org/dl/ +2. Download Go 1.5.1 and Node.js using Homebrew + 1. Download Homebrew from http://brew.sh/ + 2. `brew install go` + 3. `brew install node` 3. Set up your Go workspace 1. `mkdir ~/go` 2. Add the following to your ~/.bash_profile @@ -21,20 +24,17 @@ Developer Machine Setup If you don't increase the file handle limit you may see some weird build issues with browserify or npm. 3. Reload your bash profile `source ~/.bash_profile` -4. Install Node.js using Homebrew - 1. Download Homebrew from http://brew.sh/ - 2. `brew install node` -5. Install Compass +4. Install Compass 1. Run `ruby -v` and check the ruby version is 1.8.7 or higher 2. `sudo gem install compass` -6. Download Mattermost +5. Download Mattermost `cd ~/go` `mkdir -p src/github.com/mattermost` `cd src/github.com/mattermost` `git clone https://github.com/mattermost/platform.git` `cd platform` -7. Run unit tests on Mattermost using `make test` to make sure the installation was successful -8. If tests passed, you can now run Mattermost using `make run` +6. Run unit tests on Mattermost using `make test` to make sure the installation was successful +7. If tests passed, you can now run Mattermost using `make run` Any issues? Please let us know on our forums at: http://forum.mattermost.org @@ -64,13 +64,9 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org If you don't increase the file handle limit you may see some weird build issues with browserify or npm. 3. Reload your bashrc `source ~/.bashrc` -6. Install Node.js - 1. Download the newest version of the Node.js sources from https://nodejs.org/en/download/ - 2. Extract the contents of the package and cd into the extracted files - 3. Compile and install Node.js - `./configure` - `make` - `make install` +6. Install Node.js + `curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash -` + `sudo apt-get install -y nodejs` 7. Install Ruby and Compass `apt-get install ruby` `apt-get install ruby-dev` diff --git a/doc/developer/tests/README.md b/doc/developer/tests/README.md new file mode 100644 index 000000000..a7b36f18d --- /dev/null +++ b/doc/developer/tests/README.md @@ -0,0 +1,18 @@ +# Testing Text Processing +The text processing tests located in the [doc/developer/tests folder](https://github.com/mattermost/platform/tree/master/doc/developer/tests) are designed for use with the `/loadtest url` command. This command posts the raw contents of a specified .md file in the doc/developer/test folder into Mattermost. + +## Turning on /loadtest +Access the **System Console** from the Main Menu. Under *Service Settings* make sure that *Enable Testing* is set to `true`, then click **Save**. You may also change this setting from `config.json` by setting `”EnableTesting”: true`. Changing this setting requires a server restart to take effect. + +## Running the Tests +In the text input box in Mattermost, type: `/loadtest url [file-name-in-testing-folder].md`. Some examples: + +`/loadtest url test-emoticons.md` +`/loadtest url test-links.md` + +#### Notes: +1. If a test has prerequisites, make sure your Mattermost setup meets the requirements described at the top of the test file. +2. Some tests are over 4000 characters in length and will render across multiple posts. + +## Manual Testing +It is possible to manually test specific sections of any test, instead of using the /loadtest command. Do this by clicking **Raw** in the header for the file when it’s open in GitHub, then copy and paste any section into Mattermost to post it. Manual testing only supports sections of 4000 characters or less per post. diff --git a/doc/developer/tests/test-markdown-basics.md b/doc/developer/tests/test-markdown-basics.md new file mode 100644 index 000000000..7a46adeb0 --- /dev/null +++ b/doc/developer/tests/test-markdown-basics.md @@ -0,0 +1,139 @@ +# Basic Markdown Testing +Tests for text style, code blocks, in-line code and images, lines, block quotes, and headings. + +### Text Style + +**The following text should render as:** +_Italics_ +*Italics* +**Bold** +***Bold-italics*** +**_Bold-italics_** +~~Strikethrough~~ + +This sentence contains **bold**, _italic_, ***bold-italic***, and ~~stikethrough~~ text. + +**The following should render as normal text:** +Normal Text_ +_Normal Text +_Normal Text* + +### Code Blocks + +``` +This text should render in a code block +``` + +**The following markdown should not render:** +``` +_Italics_ +*Italics* +**Bold** +***Bold-italics*** +**Bold-italics_** +~~Strikethrough~~ +:) :-) ;) ;-) :o :O :-o :-O +:bamboo: :gift_heart: :dolls: :school_satchel: :mortar_board: +# Heading 1 +## Heading 2 +### Heading 3 +#### Heading 4 +##### Heading 5 +###### Heading 6 +> Block Quote +- List + - List Sub-item +[Link](http://i.giphy.com/xNrM4cGJ8u3ao.gif) +[](https://github.com/mattermost/platform) +| Left-Aligned Text | Center Aligned Text | Right Aligned Text | +| :------------ |:---------------:| -----:| +| Left column 1 | this text | $100 | +``` + +**The following links should not auto-link or generate previews:** +``` +GIF: http://i.giphy.com/xNrM4cGJ8u3ao.gif +Website: https://en.wikipedia.org/wiki/Dolphin +``` + +**The following should appear as a carriage return separating two lines of text:** +``` +Line #1 followed by a blank line + +Line #2 following a blank line +``` + +### In-line Code + +The word `monospace` should render as in-line code. + +The following markdown in-line code should not render: +`_Italics_`, `*Italics*`, `**Bold**`, `***Bold-italics***`, `**Bold-italics_**`, `~~Strikethrough~~`, `:)` , `:-)` , `;)` , `:-O` , `:bamboo:` , `:gift_heart:` , `:dolls:` , `# Heading 1`, `## Heading 2`, `### Heading 3`, `#### Heading 4`, `##### Heading 5`, `###### Heading 6` + +This GIF link should not preview: `http://i.giphy.com/xNrM4cGJ8u3ao.gif` +This link should not auto-link: `https://en.wikipedia.org/wiki/Dolphin` + +This sentence with ` +in-line code +` should appear on one line. + +### In-line Images + +Mattermost/platform build status: [](https://travis-ci.org/mattermost/platform) + +GitHub favicon:  + +GIF Image: + + +4K Wallpaper Image (11Mb): + + +Panorama Image: + + +Tall Portrait Image: + + + +### Lines + +Three lines should render with text between them: + +Text above line + +*** + +Text between lines + +--- + +Text between lines +___ + +Text below line + +### Block Quotes + +>This text should render in a block quote. + +**The following markdown should render within the block quote:** +> #### Heading 4 +> _Italics_, *Italics*, **Bold**, ***Bold-italics***, **Bold-italics_**, ~~Strikethrough~~ +> :) :-) ;) :-O :bamboo: :gift_heart: :dolls: + +**The following text should render in two block quotes separated by one line of text:** +> Block quote 1 + +Text between block quotes + +> Block quote 2 + +### Headings + +# Heading 1 font size +## Heading 2 font size +### Heading 3 font size +#### Heading 4 font size +##### Heading 5 font size +###### Heading 6 font size diff --git a/doc/developer/tests/test-markdown-lists.md b/doc/developer/tests/test-markdown-lists.md new file mode 100644 index 000000000..905f5b0d5 --- /dev/null +++ b/doc/developer/tests/test-markdown-lists.md @@ -0,0 +1,177 @@ +# Markdown List Testing +Verify that all list types render as expected. + +### Single-item Ordered List + +**Expected:** +``` +7. Single Item +``` + +**Actual:** +7. Single Item + +### Multi-item Ordered List + +**Expected:** +``` +1. One +2. Two +3. Three +``` + +**Actual:** +3. One +2. Two +1. Three + +### Nested Ordered List + +**Expected:** +``` +1. Alpha + 1. Bravo +2. Charlie +3. Delta + 1. Echo + 1. Foxtrot +``` + +**Actual:** +1. Alpha + 1. Bravo +1. Charlie +1. Delta + 1. Echo + 1. Foxtrot + +### Single-item Unordered List + +**Expected:** +``` +• Single Item +``` + +**Actual:** +* Single Item + +### Multi-item Unordered List + +**Expected:** +``` +• One +• Two +• Three +``` + +**Actual:** +* One +- Two ++ Three + +### Nested Unordered List + +**Expected:** +``` +• Alpha + • Bravo +• Charlie +• Delta + • Echo + • Foxtrot +``` + +**Actual:** ++ Alpha + * Bravo +- Charlie +* Delta + + Echo + - Foxtrot + +### Mixed List Starting Ordered + +**Expected:** +``` +1. One +2. Two +3. Three +``` + +**Actual:** +1. One ++ Two +- Three + +### Mixed List Starting Unordered + +**Expected:** +``` +• Monday +• Tuesday +• Wednesday +``` + +**Actual:** ++ Monday +1. Tuesday +* Wednesday + +### Nested Mixed List + +**Expected:** +``` +• Alpha + 1. Bravo + • Charlie + • Delta +• Echo +• Foxtrot + • Golf + 1. Hotel + • India + 1. Juliet + 2. Kilo + • Lima +• Mike + 1. November + 1. Oscar + 1. Papa +``` + +**Actual:** +- Alpha + 1. Bravo + * Charlie + + Delta +- Echo +* Foxtrot + + Golf + 1. Hotel + - India + 2. Juliet + 3. Kilo + * Lima +1. Mike + 1. November + 4. Oscar + 5. Papa + +### Ordered Lists Separated by Carriage Returns + +**Expected:** +``` +1. One + • Two + +1. One +2. Two +``` + +**Actual:** +1. One + - Two + + +1. One +2. Two diff --git a/doc/developer/tests/test-markdown.md b/doc/developer/tests/test-markdown.md deleted file mode 100644 index 2532e504f..000000000 --- a/doc/developer/tests/test-markdown.md +++ /dev/null @@ -1,25 +0,0 @@ -# Markdown tests - -Paste the following tests into Mattermost to test markdown support. - -``` -# This should render as Heading 1 font size -## This should render as Heading 2 font size -### This should render as Heading 3 font size -#### This should render as Heading 4 font size -##### This should render as Heading 5 font size -###### This should render as Heading 6 font size -~~This should show strikethrough formatting~~ -**This should be bold** -``` - -Here is how it should render: - -# This should render as Heading 1 font size -## This should render as Heading 2 font size -### This should render as Heading 3 font size -#### This should render as Heading 4 font size -##### This should render as Heading 5 font size -###### This should render as Heading 6 font size -~~This should show strikethrough formatting~~ -**This should be bold** diff --git a/doc/help/Notifications.md b/doc/help/Notifications.md new file mode 100644 index 000000000..31f06e713 --- /dev/null +++ b/doc/help/Notifications.md @@ -0,0 +1,31 @@ +# Notifications +___ + +Notifications in Mattermost alert you to unread mentions and messages. + +## Types of Notifications + +#### Email Notifications +These are emails sent to your primary email address for any mentions you receive while offline or inactive. +- Users are offline when they do not have Mattermost open. +- Users are inactive when they have Mattermost open but haven’t performed an action for a set amount of time. +- You can change the email to which these notifications are sent in **Account Settings** > **General** > **Email**. +- You can turn email notifications on or off in **Account Settings** > **Notifications** > **Email Notifications**. + +#### Desktop Notifications +These are browser notifications that are by default sent for all activity. +- You can adjust this setting in **Account Settings** > **Notifications** > **Send Desktop Notifications**. +- Channel specific notifications are automatically set to the global default but can be modified in **Channel Settings** > **Notification Preferences** > **Send Desktop Notifications**. +- Desktop notifications are available on Firefox, Safari, and Chrome. + + +#### Sound Notifications +These accompany each desktop notification by default. +- You can change this setting in **Account Settings** > **Notifications** > **Desktop Notification Sounds**. + + +#### Browser Tab Notifications +These appear in the Mattermost tab and inform you of any unread messages and alert you to the number of mentions you have. +- Unread messages are denoted by an asterisk (*) next to the Mattermost icon. +- Mentions and replies are denoted by a red Mattermost icon. +- The total number of unread mentions and replies are shown in brackets next to the Mattermost icon. For example, if you have 3 unread mentions, you’ll see a (3) in the browser tab. diff --git a/doc/help/README.md b/doc/help/README.md index 3b3c1709b..23c8b192d 100644 --- a/doc/help/README.md +++ b/doc/help/README.md @@ -5,13 +5,18 @@ - User Interface - Main Menu - - [Team Settings ](https://github.com/mattermost/platform/blob/help-docs-update/doc/help/Team-Settings.md) - - [General Settings](https://github.com/mattermost/platform/blob/help-docs-update/doc/help/Team-Settings.md#general) - - [Slack Import](https://github.com/mattermost/platform/blob/help-docs-update/doc/help/Team-Settings.md#import-from-slack-beta) + - [Team Settings ](Team-Settings.md) + - [General Settings](Team-Settings.md#general) + - [Slack Import](Team-Settings.md#import-from-slack-beta) - [Manage Members](Manage-Members.md) - - Messaging - - [Mattermost Markdown Formatting](help/Markdown.md) + - [Account Settings](Account-Settings.md) + - [Messaging](Messaging.md) + - [Mattermost Markdown Formatting](Markdown.md) - [Search](Search.md) + - [Channels](Channels.md) + - [Channel Types](Channels.md#channel-types) + - [Managing Channels](Channels.md#managing-channels) + - [Channel Settings](Channels.md#channel-settings) - System Console - Team diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index a92893753..44730d40f 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -29,7 +29,12 @@ Set this key to enable embedding of YouTube video previews based on hyperlinks a #### Webhooks ```"EnableIncomingWebhooks": true``` -Developers building integrations can create webhook URLs for channels and private groups. Please see http://mattermost.org/webhooks to learn about creating webhooks, view samples, and to let the community know about integrations you have built. "true": Incoming webhooks will be allowed. To manage incoming webhooks, go to Account Settings -> Integrations. The webhook URLs created in Account Settings can be used by external applications to create posts in any channels or private groups that you have access to; “false”: The Integrations tab of Account Settings is hidden and incoming webhooks are disabled. +Developers building integrations can create webhook URLs for channels and private groups. Please see http://mattermost.org/webhooks to learn about creating webhooks, view samples, and to let the community know about integrations you have built. "true": Incoming webhooks will be allowed. To manage incoming webhooks, go to **Account Settings -> Integrations**. The webhook URLs created in Account Settings can be used by external applications to create posts in any channels or private groups that you have access to; “false”: The Integrations > Incoming Webhooks section of Account Settings is hidden and all incoming webhooks are disabled. + +Security note: By enabling this feature, users may be able to perform [phishing attacks](https://en.wikipedia.org/wiki/Phishing) by attempting to impersonate other users. To combat these attacks, a BOT tag appears next to all posts from a webhook. Enable at your own risk. + +```"EnableOutgoingWebhooks": true``` +Developers building integrations can create webhook tokens for public channels. Trigger words are used to fire new message events to external integrations. For security reasons, outgoing webhooks are only available in public channels. Please see our [documentation page](https://github.com/mattermost/platform/blob/master/doc/integrations/webhooks/Outgoing-Webhooks.md) to learn about creating webhooks and view samples. "true": Outgoing webhooks will be allowed. To manage outgoing webhooks, go to **Account Settings -> Integrations**; “false”: The Integrations > Outgoing Webhooks section of Account Settings is hidden and all outgoing webhooks are disabled. Security note: By enabling this feature, users may be able to perform [phishing attacks](https://en.wikipedia.org/wiki/Phishing) by attempting to impersonate other users. To combat these attacks, a BOT tag appears next to all posts from a webhook. Enable at your own risk. @@ -58,6 +63,12 @@ Maximum number of users per team, including both active and inactive users. ```"RestrictCreationToDomains": ""``` Teams can only be created by a verified email from this list of comma-separated domains (e.g. "corp.mattermost.com, mattermost.org"). +```"RestrictTeamNames": true``` +"true": Newly created team names cannot contain the following restricted words: www, web, admin, support, notify, test, demo, mail, team, channel, internal, localhost, dockerhost, stag, post, cluster, api, oauth; “false”: Newly created team names are not restricted. + +```"EnableTeamListing": false``` +"true": Teams that are configured to appear in the team directory will appear on the system main page. Teams can configure this setting from **Team Settings -> Include this team in the Team Directory**; "true": Team directory on the system main page is disabled. + ### SQL Settings diff --git a/doc/process/overview.md b/doc/process/overview.md index af632e393..b34908782 100644 --- a/doc/process/overview.md +++ b/doc/process/overview.md @@ -64,7 +64,7 @@ Mattermost priorities are managed in Jira tickets, which are created by the core On non-holiday weekdays new tickets are reviewed in a process called "triage", and assigned a Fix Version of "backlog", indicating the ticket has enough specificity that it can be assigned to a developer to be completed. -By default, all tickets are created as internal-only, and the triage process reviews them for sufficient specifity and abscense of sensitive information before switching their visibility to public as part of the triage process. +By default, all tickets are created as public unless they contain sensitive information. The triage process reviews them for sufficient specifity. If the ticket is unclear, triage may reassign the ticket back to the original reporter to add more details. View [current issues scheduled for the next triage meeting](https://mattermost.atlassian.net/browse/PLT-1203?filter=10105). |