diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/help/Account-Settings.md | 9 | ||||
| -rw-r--r-- | doc/help/Markdown.md | 13 | ||||
| -rw-r--r-- | doc/help/Messaging.md | 12 | ||||
| -rw-r--r-- | doc/install/Upgrade-Guide.md | 2 | ||||
| -rw-r--r-- | doc/process/overview.md | 8 |
5 files changed, 37 insertions, 7 deletions
diff --git a/doc/help/Account-Settings.md b/doc/help/Account-Settings.md index a0c55d3e9..1e05ef2ad 100644 --- a/doc/help/Account-Settings.md +++ b/doc/help/Account-Settings.md @@ -93,6 +93,9 @@ Outgoing webhooks use trigger words to fire new message events to external integ ##Display Settings to configure clock and teammate name display preferences. +#### Display Font +Select what font is used. + #### Clock Display Choose a 12-hour or 24-hour time preference that appears on the time stamp for all posts. @@ -104,3 +107,9 @@ Setting to configure when messages are sent. #### Send Messages on Ctrl+Enter If enabled, press **Enter** to insert a new line and **Ctrl + Enter** posts the message. If disabled, **Shift + Enter** inserts a new line and **Enter** posts the message. + +#### Preview pre-release features +Turn on preview features to view them early, ahead of their official release: +- **Show markdown preview option in message input box:** Turning this on will show a "Preview" option when typing in the text input box. Pressing "Preview" shows what the Markdown formatting in the message looks like before the message is sent. +- **Show preview snippet of links below message:** Turning this on will show a preview snippet posted below links from select websites. + diff --git a/doc/help/Markdown.md b/doc/help/Markdown.md index 1befed8d4..64ce4fc83 100644 --- a/doc/help/Markdown.md +++ b/doc/help/Markdown.md @@ -88,7 +88,7 @@ and ## Emojis -Check out a full list of emojis [here](http://www.emoji-cheat-sheet.com/). +Emoji provided free by [Emoji One](http://emojione.com/). Check out a full list of emojis [here](http://http://emoji.codes/). ``` :smile: :+1: :sheep: @@ -132,6 +132,17 @@ Renders as: 1. Item one 2. Item two +Make a task list by including square brackets: +``` +- [ ] Item one +- [ ] Item two +- [x] Completed item +``` +Renders as: +- [ ] Item one +- [ ] Item two +- [x] Completed item + ## Tables: Create a table by placing a dashed line under the header row and separating the columns with a pipe `|`. (The columns don’t need to line up exactly for it to work). Choose how to align table columns by including colons `:` within the header row. diff --git a/doc/help/Messaging.md b/doc/help/Messaging.md index cc26a948e..548892650 100644 --- a/doc/help/Messaging.md +++ b/doc/help/Messaging.md @@ -18,7 +18,8 @@ Mattermost messages are formatted using a standard called "markdown". Here are e |``|| |`:smile:` `:sheep:` `:alien:`|:smile: :sheep: :alien:| -Check out a full list of Emojis [here](http://www.emoji-cheat-sheet.com/). +Emojis provided free from [Emoji One](http://emojione.com/). Check out a full list of Emojis [here](http://emoji.codes/). + ## Mentioning Teammates @@ -35,3 +36,12 @@ Which sends a special mention notification to **alice** to check your message. To mention a teammate, press `@` and you should see a list of team members who can be messaged. You can either type their username or use the **Up** and **Down** arrow keys and then **ENTER** to select them to be mentioned. You can configure how you'd like to be alerted about mentions of your username, your first name, your nickname, or other keywords from **Account Settings** > **Notifications** and you can set channel-specific preferences from **[Channel Name]** > **Notification Preferences** + +## Messages Dropdown Menu + +To get to the Messages Dropdown Menu, hover over a message and click on the [...] menu. This shows a dropdown list containing additional actions you can perform on a message: + +- **Reply:** Opens up the sidebar so you can reply to a message in a comment thread. +- **Permalink:** Creates a link to the message. Sharing this link with other users in the channel lets them view the linked message in the Message Archives. +- **Delete:** Deletes the message so it is no longer visible. Team Administrators and System Administrators can also delete another user's message. +- **Edit:** Lets you edit your own message. diff --git a/doc/install/Upgrade-Guide.md b/doc/install/Upgrade-Guide.md index e01bdb9a0..edcc754f8 100644 --- a/doc/install/Upgrade-Guide.md +++ b/doc/install/Upgrade-Guide.md @@ -15,7 +15,7 @@ If you're upgrading across multiple major releases, from 1.0.x to 1.2.x for exam 3. Review Release Notes 1. Check the release notes for the version of Mattermost you are able to install, and note any setting changes in the **Compatibility** section that apply to your deployment (Release notes across versions are available from the [CHANGELOG](https://github.com/mattermost/platform/blob/master/CHANGELOG.md)). 4. Download the `mattermost.tar.gz` file with the correct version for your upgrade - 1. You can use `wget` to retrieve a specific version. For example, to download v1.1.0 run `wget https://github.com/mattermost/platform/releases/download/v1.1.0/mattermost.tar.gz` + 1. You can use `wget` to retrieve a specific version. For example, to download v1.1.0 run `wget https://github.com/mattermost/platform/releases/download/v1.x.x/mattermost.tar.gz` 2. Stop the Mattermost Server 1. As best practice, consider posting to the Town Square channel of active teams pre-announcing the scheduled downtime to apply these upgrade procedures 2. To stop the server run `sudo stop mattermost` diff --git a/doc/process/overview.md b/doc/process/overview.md index a1201a8d6..8a4c0459d 100644 --- a/doc/process/overview.md +++ b/doc/process/overview.md @@ -1,6 +1,6 @@ # Development Process Overview -This document describes the process through which feedback and design discussions flow into community systems, then into tickets, then into merge requests, then into monthly releases based on the purpose of the product. +This document describes the process through which feedback and design discussions flow into community systems, then into tickets, then into pull requests, then into monthly releases based on the purpose of the product. ## Purpose @@ -44,7 +44,7 @@ Please consider using more mainstream processes for [filing feature ideas to be ### GitHub Pull Requests -A system for submitting merge requests for changes to Mattermost. See [Merge Requests](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#merge-requests) section below. +A system for submitting pull requests for changes to Mattermost. See [Pull Requests](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#merge-requests) section below. ### General Forum @@ -80,7 +80,7 @@ Release planning sets the "Fix Version" of tickets to one of the upcoming monthl Tickets to be completed in the upcoming two weeks are organized on Tuesdays, with input from developers, and finalized on Fridays. -## Merge Requests +## Pull Requests ### Core Team Weekly Rhythm @@ -92,7 +92,7 @@ Key contributors might also pick up tickets, or through conversations with the c ### Community Contributions -Community members following the Contribution Guidelines might also submit pull requests. +Community members following the [Contribution Guidelines](https://github.com/mattermost/platform/blob/master/CONTRIBUTING.md) might also submit pull requests. Pull requests should not disable existing functionality without a Jira ticket, which are opened [via the feature ideas process](http://www.mattermost.org/feature-requests/). #### Bug Fixes |