diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/tests/test-attachments.md | 144 | ||||
| -rw-r--r-- | doc/developer/tests/test-emoticons.md | 2 | ||||
| -rw-r--r-- | doc/developer/tests/test-markdown-lists.md | 53 | ||||
| -rw-r--r-- | doc/developer/tests/test-syntax-highlighting.md | 231 | ||||
| -rw-r--r-- | doc/developer/tests/test-tables.md | 80 | ||||
| -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/help/Search.md | 3 | ||||
| -rw-r--r-- | doc/help/Sign-in.md | 14 | ||||
| -rw-r--r-- | doc/install/Configuration-Settings.md | 22 | ||||
| -rw-r--r-- | doc/install/Requirements.md | 6 | ||||
| -rw-r--r-- | doc/install/Upgrade-Guide.md | 2 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming-Webhooks.md | 4 | ||||
| -rw-r--r-- | doc/process/overview.md | 8 | ||||
| -rw-r--r-- | doc/process/release-process.md | 141 |
16 files changed, 646 insertions, 98 deletions
diff --git a/doc/developer/tests/test-attachments.md b/doc/developer/tests/test-attachments.md new file mode 100644 index 000000000..71cc496ce --- /dev/null +++ b/doc/developer/tests/test-attachments.md @@ -0,0 +1,144 @@ +# Testing Files and Attachments +This test contains instructions for the core team to manually test common attachment types. All files for testing are stored in the [mm_file_testing](https://www.dropbox.com/sh/i7ft8is5hbhk8ii/AAAyM-WG-X2jiQOgg6-E3MmLa?dl=0) dropbox folder. Follow these instructions: + +1. Download the entire [mm_file_testing](https://www.dropbox.com/sh/i7ft8is5hbhk8ii/AAAyM-WG-X2jiQOgg6-E3MmLa?dl=0) folder. +2. Drag and drop each file type into Mattermost to upload it. +3. Post the file attachment + +**Notes:** +- All file types should upload and post. +- Read the expected for details on the behavior of the thumbnail and preview window. +- The expected behavior of video and audio formats depends on the operating system, browser and plugins. View the permalinks to the Public Test Channel on Pre-Release Core to see the expected cases. + + +### Images +**JPG** +`Images/JPG.jpg` +Expected: Scaled thumbnail & preview window +[Permalink](https://pre-release.mattermost.com/core/pl/bgx3wcd9ppdo7fz9zqokofg7sc) + +**PNG** +`Images/PNG.png` +Expected: Scaled thumbnail & preview window +[Permalink](https://pre-release.mattermost.com/core/pl/zra4yhm69j8ij81iy5hw7983qe) + +**BMP** +`Images/BMP.bmp` +Expected: Scaled thumbnail & preview window +[Permalink](https://pre-release.mattermost.com/core/pl/1hx7x7t1npn4jqyr5rb1qhbj3h) + +**GIF** +`Images/GIF.gif` +Expected: Scaled thumbnail & preview window. Click to play GIF. +[Permalink](https://pre-release.mattermost.com/core/pl/j49fowdkstr57g3ed9bgpfoo5w) + +**TIFF** +`Images/TIFF.tiff` +Expected: Generic attachment thumbnail & preview window +[Permalink](https://pre-release.mattermost.com/core/pl/6yad4jydaidr3pc3tihp8n8bge) + +**PSD** +`Images/PSD.psd` +Expected: Generic attachment thumbnail & preview window +[Permalink](https://pre-release.mattermost.com/core/pl/4kitwk7pi78c9ck4i98f9xnzoe) + + +### Documents + +**PDF Files** +`Documents/PDF.pdf` +Expected: Generic PDF thumbnail & preview window. +[Permalink](https://pre-release.mattermost.com/core/pl/o1dg6menetdszrhyxmtoqjfi8h) + + +**Excel** +`Documents/Excel.xlsx` +Expected: Generic Excel thumbnail & preview window. +[Permalink](https://pre-release.mattermost.com/core/pl/71wwezy3f7drze6ipundscb17y) + + +**PPT** +`Documents/PPT.pptx` +Expected: Generic Powerpoint thumbnail & preview window. +[Permalink](https://pre-release.mattermost.com/core/pl/mx37h4znwb8f5ffuoajusqhiew) + +**Word** +`Documents/Word.docx` +Expected: Generic Word thumbnail & preview window. +[Permalink](https://pre-release.mattermost.com/core/pl/d7s76wp6kjdwfp4hgrwpijsnyy) + + +### Videos + +**MP4** +`Videos/MP4.mp4` +Expected: Generic video thumbnail & playable preview window +[Permalink](https://pre-release.mattermost.com/core/pl/5dx5qx9t9brqfnhohccxjynx7c) + +**AVI** +`Videos/AVI.avi` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/qwn9eiy7j3rkjyruxhcugpogdw) + +**MKV** +`Videos/MKV.mkv` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/tszyjkr1cidhxjgiusa4mde3ja) + +**MOV** +`Videos/MOV.mov` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/ienzppz5i3f7tbt5jiujn8uuir) + +**MPG** +`Videos/MPG.mpg` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/skggdq1hfpritc6c88bi481p5a) + +**Webm** +`Videos/WEBM.webm` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/7h8tysuxgfgsxeht3sbn7e4h6y) + +**WMV** +`Videos/WMV.wmv` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/kaom7j7uyjra7bzhrre6qwdrbw) + +### Audio + +**MP3** +`Audio/MP3.mp3` +Expected: Generic audio thumbnail & playable preview window +[Permalink](https://pre-release.mattermost.com/core/pl/if4gn8dbrjgx8fmqmkukzefyme) + + +**M4A** +`Audio/M4a.m4a` +Expected: Generic audio thumbnail & playable preview window +[Permalink](https://pre-release.mattermost.com/core/pl/6c7qsw48ybd88bktgeykodsrrc) + +**AAC** +`Audio/AAC.aac` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/3naoy5pr5tydbk1m6yo1ast9ny) + +**FLAC** +`Audio/FLAC.flac` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/kf4cmy44dfya5efmse7rg43eih) + +**OGG** +`Audio/OGG.ogg` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/dezrcpbxapyexe77rjuzkrp63r) + +**WAV** +`Audio/WAV.wav` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/pdkxx1udepdnbmi9j8kyas5xbh) + +**WMA** +`Audio/WMA.wma` +Expected: View Permalink. Expected depends on the operating system, browser and plugins. +[Permalink](https://pre-release.mattermost.com/core/pl/756wrmdd57dcig3m4emypp6i1h) diff --git a/doc/developer/tests/test-emoticons.md b/doc/developer/tests/test-emoticons.md index 6338d7333..fc2594d9e 100644 --- a/doc/developer/tests/test-emoticons.md +++ b/doc/developer/tests/test-emoticons.md @@ -3,7 +3,7 @@ Verify that all emoticons render. This test should render in three separate mess ### Emoticon - Punctuation -:) :-) ;) ;-) :o :O :-o :-O :] :-] :d :-D x-d x-D :p :-P :@ :( :-( :'( :* :-* :/ :-/ :s :-s :| :-| :$ :-$ :-x <3 :+1: :-1: +:) :-) ;) ;-) :o :O :-o :-O :] :-] :d :-D x-d x-D :p :-P :@ :( :-( :'( :/ :-/ :s :-s :| :-| :$ :-$ :-x <3 :+1: :-1: ### Emoticons - People :bowtie: :smile: :laughing: :blush: :smiley: :relaxed: :smirk: :heart_eyes: :kissing_heart: :kissing_closed_eyes: :flushed: :relieved: :satisfied: :grin: :wink: :stuck_out_tongue_winking_eye: :stuck_out_tongue_closed_eyes: :grinning: :kissing: :kissing_smiling_eyes: :stuck_out_tongue: :sleeping: :worried: :frowning: :anguished: :open_mouth: :grimacing: :confused: :hushed: :expressionless: :unamused: :sweat_smile: :sweat: :disappointed_relieved: :weary: :pensive: :disappointed: :confounded: :fearful: :cold_sweat: :persevere: :cry: :sob: :joy: :astonished: :scream: :neckbeard: :tired_face: :angry: :rage: :triumph: :sleepy: :yum: :mask: :sunglasses: :dizzy_face: :imp: :smiling_imp: :neutral_face: :no_mouth: :innocent: :alien: :yellow_heart: :blue_heart: :purple_heart: :heart: :green_heart: :broken_heart: :heartbeat: :heartpulse: :two_hearts: :revolving_hearts: :cupid: :sparkling_heart: :sparkles: :star: :star2: :dizzy: :boom: :collision: :anger: :exclamation: :question: :grey_exclamation: :grey_question: :zzz: :dash: :sweat_drops: :notes: :musical_note: :fire: :hankey: :poop: :shit: :+1: :thumbsup: :-1: :thumbsdown: :ok_hand: :punch: :facepunch: :fist: :v: :wave: :hand: :raised_hand: :open_hands: :point_up: :point_down: :point_left: :point_right: :raised_hands: :pray: :point_up_2: :clap: :muscle: :metal: :fu: :runner: :running: :couple: :family: :two_men_holding_hands: :two_women_holding_hands: :dancer: :dancers: :ok_woman: :no_good: :information_desk_person: :raising_hand: :bride_with_veil: :person_with_pouting_face: :person_frowning: :bow: :couplekiss: :couple_with_heart: :massage: :haircut: :nail_care: :boy: :girl: :woman: :man: :baby: :older_woman: :older_man: :person_with_blond_hair: :man_with_gua_pi_mao: :man_with_turban: :construction_worker: :cop: :angel: :princess: :smiley_cat: :smile_cat: :heart_eyes_cat: :kissing_cat: :smirk_cat: :scream_cat: :crying_cat_face: :joy_cat: :pouting_cat: :japanese_ogre: :japanese_goblin: :see_no_evil: :hear_no_evil: :speak_no_evil: :guardsman: :skull: :feet: :lips: :kiss: :droplet: :ear: :eyes: :nose: :tongue: :love_letter: :bust_in_silhouette: :busts_in_silhouette: :speech_balloon: :thought_balloon: :feelsgood: :finnadie: :goberserk: :godmode: :hurtrealbad: :rage1: :rage2: :rage3: :rage4: :suspect: :trollface: diff --git a/doc/developer/tests/test-markdown-lists.md b/doc/developer/tests/test-markdown-lists.md index 905350d31..d5bbd82ac 100644 --- a/doc/developer/tests/test-markdown-lists.md +++ b/doc/developer/tests/test-markdown-lists.md @@ -21,6 +21,7 @@ Verify that all list types render as expected. ``` **Actual:** + 3. One 2. Two 1. Three @@ -38,12 +39,13 @@ Verify that all list types render as expected. ``` **Actual:** -1. Alpha - 1. Bravo + +1. Alpha + 1. Bravo 1. Charlie 1. Delta - 1. Echo - 1. Foxtrot + 1. Echo + 1. Foxtrot ### Single-item Unordered List @@ -99,6 +101,7 @@ Verify that all list types render as expected. ``` **Actual:** + 1. One + Two - Three @@ -169,10 +172,11 @@ Verify that all list types render as expected. ``` **Actual:** + 1. One - - Two - - + - Two + + 1. One 2. Two @@ -186,7 +190,42 @@ This text should be on a new line. ``` **Actual:** + 1. One - Two This text should be on a new line. +### Task Lists + +**Expected:** +``` +[ ] One + [ ] Subpoint one + - Normal Bullet +[ ] Two +[x] Completed item +``` + +**Actual:** + +- [ ] One + - [ ] Subpoint one + - Normal Bullet +- [ ] Two +- [x] Completed item + +### Numbered Task Lists + +**Expected:** +``` +1. [ ] One +2. [ ] Two +3. [x] Completed item +``` + +**Actual:** + +1. [ ] One +2. [ ] Two +3. [x] Completed item + diff --git a/doc/developer/tests/test-syntax-highlighting.md b/doc/developer/tests/test-syntax-highlighting.md new file mode 100644 index 000000000..7f8f4cdaa --- /dev/null +++ b/doc/developer/tests/test-syntax-highlighting.md @@ -0,0 +1,231 @@ +# Code Syntax Highlighting + +Verify the following code blocks render as code blocks and highlight properly. + +### Diff + +``` diff +*** /path/to/original ''timestamp'' +--- /path/to/new ''timestamp'' +*************** +*** 1 **** +! This is a line. +--- 1 --- +! This is a replacement line. +It is important to spell +-removed line ++new line +``` + +### Apache + +``` apache +<VirtualHost *:80> +DocumentRoot /www/example1 +ServerName www.example.com +</VirtualHost> +``` + +### Makefile + +``` makefile +CC=gcc +CFLAGS=-I. + +hellomake: hellomake.o hellofunc.o + $(CC) -o hellomake hellomake.o hellofunc.o -I. +``` + +### HTTP + +``` http +HTTP/1.1 200 OK +Date: Sun, 28 Dec 2014 08:56:53 GMT +Content-Length: 44 +Content-Type: text/html + +<html><body><h1>It works!</h1></body></html> +``` + +### JSON + +``` json +{"employees":[ + {"firstName":"John", "lastName":"Doe"}, +]} +``` + +### Markdown + +``` markdown +**bold** +*italics* +[link](www.example.com) +``` + +### JavaScript + +``` javascript +document.write('Hello, world!'); +``` + +### CSS + +``` css +body { + background-color: red; +} +``` + +### NGINX + +``` nginx +server { # simple reverse-proxy + listen 80; + server_name domain2.com www.domain2.com; + access_log logs/domain2.access.log main; +``` + +### Objective C + +``` objectivec +#import <stdio.h> + +int main (void) +{ + printf ("Hello world!\n"); +} +``` + +### Python + +``` python +print "Hello, world!" +``` + +### XML + +``` xml +<employees> + <employee> + <firstName>John</firstName> <lastName>Doe</lastName> + </employee> +</employees> +``` + +### Perl + +``` perl +print "Hello, World!\n"; +``` + +### Bash + +``` bash +echo "Hello World" +``` + +### PHP + +``` php + <?php echo '<p>Hello World</p>'; ?> +``` + +### CoffeeScript + +``` coffee +console.log(“Hello world!”); +``` + +### C# + +``` cs +using System; +class Program +{ + public static void Main(string[] args) + { + Console.WriteLine("Hello, world!"); + } +} +``` + +### C++ + +``` cpp +#include <iostream.h> + +main() +{ + cout << "Hello World!"; + return 0; +} +``` + +### SQL + +``` sql +SELECT column_name,column_name +FROM table_name; +``` + +### Go + +``` go +package main +import "fmt" +func main() { + fmt.Println("Hello, 世界") +} +``` + +### Ruby + +``` ruby +puts "Hello, world!" +``` + +### Java + +``` java +import javax.swing.JFrame; //Importing class JFrame +import javax.swing.JLabel; //Importing class JLabel +public class HelloWorld { + public static void main(String[] args) { + JFrame frame = new JFrame(); //Creating frame + frame.setTitle("Hi!"); //Setting title frame + frame.add(new JLabel("Hello, world!"));//Adding text to frame + frame.pack(); //Setting size to smallest + frame.setLocationRelativeTo(null); //Centering frame + frame.setVisible(true); //Showing frame + } +} +``` + +### INI + +``` ini +; last modified 1 April 2011 by John Doe +[owner] +name=John Doe +organization=Mattermost +``` + +### Latex Equation + +``` latex +\frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x). +``` + +### Latex Document + +``` latex +\documentclass{article} +\begin{document} +\noindent +Are $a, b \in \mathbb{R}, then applies (a+b)^{2} = a^{2} + ab + b^{2} $ \\ +better \\ +are $a, b \in \mathbb{R}, \textrm{then applies} \, (a+b)^{2 } = a^{2 } + ab + b^{2}$\\ +\end{document} +``` + diff --git a/doc/developer/tests/test-tables.md b/doc/developer/tests/test-tables.md new file mode 100644 index 000000000..87d8af856 --- /dev/null +++ b/doc/developer/tests/test-tables.md @@ -0,0 +1,80 @@ +# Markdown Tables + +Verify that all tables render as described. + +### Normal Tables + +These tables use different raw text as inputs, but all three should render as the same table. + +#### Table 1 + +Raw text: + +``` +First Header | Second Header +------------- | ------------- +Content Cell | Content Cell +Content Cell | Content Cell +``` + +Renders as: + +First Header | Second Header +------------- | ------------- +Content Cell | Content Cell +Content Cell | Content Cell + +#### Table 2 + +Raw Text: + +``` +| First Header | Second Header | +| ------------- | ------------- | +| Content Cell | Content Cell | +| Content Cell | Content Cell | +``` + +Renders as: + +| First Header | Second Header | +| ------------- | ------------- | +| Content Cell | Content Cell | +| Content Cell | Content Cell | + +#### Table 3 + +Raw Text: + +``` +| First Header | Second Header | +| ------------- | ----------- | +| Content Cell | Content Cell| +| Content Cell | Content Cell | +``` + +Renders as: + +| First Header | Second Header | +| ------------- | ----------- | +| Content Cell | Content Cell| +| Content Cell | Content Cell | + +### Tables Containing Markdown + +This table should contain A1: Strikethrough, A2: Bold, B1: Italics, B2: Dolphin emoticon. + +| Column\Row | 1 | 2 | +| ------------- | ------------- |------------- | +| A | ~~Strikethrough~~ | **Bold** | +| B | _italics_ | :dolphin: | + +### Table with Left, Center, and Right Aligned Columns + +The left column should be left aligned, the center column centered and the right column should be right aligned. + +| Left-Aligned | Center Aligned | Right Aligned | +| :------------ |:---------------:| -----:| +| 1 | this text | $100 | +| 2 | is | $10 | +| 3 | centered | $1 | 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/help/Search.md b/doc/help/Search.md index 51095aac6..354e29a43 100644 --- a/doc/help/Search.md +++ b/doc/help/Search.md @@ -7,7 +7,8 @@ The search box in Mattermost brings back results from any channel of which you - Multiple search terms are connected with “OR” by default. Typing in `Mattermost website` returns results containing “Mattermost” or “website” - Use `from:` to find posts from specific users and `in:` to find posts in specific channels. For example: Searching `Mattermost in:town-square` only returns messages in Town Square that contain `Mattermost` - Use quotes to return search results for exact terms. For example: Searching `"Mattermost website"` returns messages containing the entire phrase `"Mattermost website"` and not messages containing only `Mattermost` or `website` -- Use the `*` character for wildcard searches that match within words. For example: Searching for `rea*` brings back messages containing `reach`, `reason` and other words starting with `rea`. +- Use the `*` character for wildcard searches that match within words. For example: Searching for `rea*` brings back messages containing `reach`, `reason` and other words starting with `rea` +- Click on the **Jump** link on the right of a search result to view the post archive in the center channel #### Limitations: diff --git a/doc/help/Sign-in.md b/doc/help/Sign-in.md index f8e353cce..5b7b375c7 100644 --- a/doc/help/Sign-in.md +++ b/doc/help/Sign-in.md @@ -2,22 +2,26 @@ You can sign-in to your team from the web address of `https://domain.com/teamname`. -There are several options for signing in depending on how your System Administrator has configured your server. +There are several options for signing in to your team depending on how your System Administrator has configured your server. #### Email address and password sign-in -If available, you can sign in using the combination of email address and password used to create your account. +When enabled by your System Administrator, you can sign in using the combination of email address and password used to create your account. If you have forgotten your password, you should be able to reset it from the "I forgot my password" option on the sign-in screen, or contact your System Administrator if you need help resetting your password. #### GitLab Single-Sign-On (SSO) option -If available, you can sign in using your GitLab account using a one-click sign-in option. GitLab SSO lets you create teams, create accounts on teams, and sign-in to teams using one username, email address, and password that works across everything on the server. +When enabled by your System Administrator, you can sign-in using your GitLab account using a one-click sign-in option. GitLab SSO lets you create teams, create accounts on teams, and sign-in to teams using one username, email address, and password that works across everything on the server. #### Switching Teams -You can switch among teams you've recently signed into using the main menu in any team site on the server. By default, devices remember which teams you have signed into for 30 days, and this duration is configurable by the System Administrator. +When you've used the same email address to sign-up and sign-in to multiple teams, you can switch among those teams using the main menu in any team site on the server. By default, devices remember which teams you have signed into for 30 days. + +#### System Adminstrator Role + +If your account in a given team has been given the System Administrator role, it has access to the System Console. The System Administrator role does not apply to accounts created in other teams using the same email address, since user accounts are unique to teams. #### Logging Out -You can log out from the main menu, which is accessed by clicking the three dots in the top header on the left side of the screen. Clicking "Logout" logs you out of all the teams you are signed into on the site. +You can log out from the main menu, which is accessed by clicking the three dots in the top header on the left side of the screen. Clicking "Logout" logs you out of all the teams you are signed-in to that share the same email address. diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index 66fda15e0..5f9b3b62d 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -141,9 +141,16 @@ Port of SMTP email server. ```"InviteSalt": "bjlSR4QqkXFBr7TP4oDzlfZmcNuH9YoS"``` 32-character (to be randomly generated via Admin Console) salt added to signing of email invites. - ```"PasswordResetSalt": "vZ4DcKyVVRlKHHJpexcuXzojkE5PZ5eL"``` -32-character (to be randomly generated via Admin Console) salt added to signing of password reset emails. +32-character (to be randomly generated via Admin Console) salt added to signing of password reset emails. + +#### Push Notification Settings + +```"SendPushNotifications": false``` +"true": Your mattermsot server sends mobile push notifications to the server specified in **PushNotificationServer**; "false": Mobile push notifications are disabled. + +```"PushNotificationServer": ""``` +Address of the proxy server that re-sends push notifications to their respective services like APNS (Apple Push Notification Services). ### File Settings @@ -291,17 +298,6 @@ System Console allows an IT Admin to update settings defined in `config.json`. H ```"EnableOAuthServiceProvider": false``` ”true”: Allow Mattermost to function as an OAuth provider, allowing 3rd party apps access to your user store for authentication. -### Push Notification Settings - -```"ApplePushServer": ""``` -Setting for features in development. - -```"ApplePushCertPublic": ""``` -Setting for features in development. - -```"ApplePushCertPrivate": ""``` -Setting for features in development. - ### File Settings ```"InitialFont": "luximbi.ttf"``` diff --git a/doc/install/Requirements.md b/doc/install/Requirements.md index b877b6dc0..162caf90d 100644 --- a/doc/install/Requirements.md +++ b/doc/install/Requirements.md @@ -4,10 +4,10 @@ Supported Operating Systems and Browsers for the Mattermost Web Client include: -- PC: Windows 7, Windows 8 (Chrome 43+, Firefox 38+, Internet Explorer 10+) -- Mac: OS 10 (Safari 7, Chrome 43+) +- PC: Windows 7, Windows 8, Windows 10 (Chrome 43+, Firefox 38+, Internet Explorer 11, Edge) +- Mac: OS 10 (Safari 9, Chrome 43+) - Linux: Arch 4.0.0 (Chrome 43+) -- iPhone 4s and higher (Safari on iOS 8.3+, Chrome 43+) +- iPhone 4s and higher (Safari on iOS 9+, Chrome 43+) - Android 5 and higher (Chrome 43+) ### Email Client 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/integrations/webhooks/Incoming-Webhooks.md b/doc/integrations/webhooks/Incoming-Webhooks.md index 5e93c4ac7..7373892ad 100644 --- a/doc/integrations/webhooks/Incoming-Webhooks.md +++ b/doc/integrations/webhooks/Incoming-Webhooks.md @@ -1,6 +1,6 @@ # Incoming Webhooks -Incoming webhooks allow external applications, written in the programming language of your choice--to post messages into Mattermost channels and private groups by sending a specifically formatted JSON payload via HTTP POST request to a secret Mattermost URL generated specifically for each application. +Incoming webhooks allow external applications, written in the programming language of your choice--to post messages into Mattermost channels, private groups and direct messages by sending a specifically formatted JSON payload via HTTP POST request to a secret Mattermost URL generated specifically for each application. A couple key points: @@ -69,7 +69,7 @@ Additional Notes: 1. For the HTTP request body, if `Content-Type` is specified as `application/json` in the headers of the HTTP request then the body of the request can be direct JSON. For example, ```{"text": "Hello, this is some text."}``` -2. You can override the channel specified in the webhook definition by specifying a `channel` parameter in your payload. For example, you might have a single webhook created for _Town Square_, but you can use ```payload={"channel": "off-topic", "text": "Hello, this is some text."}``` to send a message to the _Off-Topic_ channel using the same webhook URL +2. You can override the channel specified in the webhook definition by specifying a `channel` parameter in your payload. For example, you might have a single webhook created for _Town Square_, but you can use ```payload={"channel": "off-topic", "text": "Hello, this is some text."}``` to send a message to the _Off-Topic_ channel using the same webhook URL. If an `@` symbol followed by a username is specified, then the message will be sent to that user's direct message channel 1. In addition, with **Enable Overriding of Usernames from Webhooks** turned on, you can also override the username the message posts as by providing a `username` parameter in your JSON payload. For example, you might want your message looking like it came from a robot so you can use ```payload={"username": "robot", "text": "Hello, this is some text."}``` to change the username of the post to robot. Note, to combat any malicious users from trying to use this to perform [phishing attacks](https://en.wikipedia.org/wiki/Phishing) a `BOT` indicator appears next to posts coming from webhooks 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 diff --git a/doc/process/release-process.md b/doc/process/release-process.md index 96bd2b050..294f5aa79 100644 --- a/doc/process/release-process.md +++ b/doc/process/release-process.md @@ -1,68 +1,81 @@ -We're working on making internal processes in the Mattermost core team more transparent for the community. Below is a working draft of our software development process, which will be updated live as we refine our process. - -Questions, feedback, comments always welcome, - ----------- +# Mattermost Release Process Mattermost core team works on a monthly release process, with a new version shipping on the 16th of each month. This document outlines the development process for the Mattermost core team, which draws from what we find works best for us from Agile, Scrum and Software Development Lifecycle approaches. -This is a working document that will update as our process evolves. - +Notes: +- All cut-off dates are based on 10am PST (UTC-07/08) on the day stated. +- T-minus counts are measured in "working days" (weekdays other than major holidays concurrent in US and Canada) prior to release day. -### - Beginning of release -- (Ops) Queue an agenda item for first team meeting of the release to review Roadmap +### (Code complete date of previous release) Beginning of release +- Pre-work for the current release begins at the code complete date of the previous release. See "Code Complete" section below for details. -### - (10 weekdays before release date) Cut-off for major features -- No major features can be committed to the current release after this date -- (Dev) Prioritize reviewing, updating, and merging of all pull requests that are going to make it into the release - - There should be no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +### (T-minus 10 working days) Cut-off for major features +- No pull requests for major features should be submitted to the current release after this date (except if release manager decides to add "release-exception" label) +- (Ops) Post this checklist in Release channel +- (PM) Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) +- (PM) Confirm changes to config.json in compatibility section of Changelog are written back to [settings documentation](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) +- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release - (Leads) Meets to prioritize the final tickets of the release - Backlog is reviewed and major features that won’t make it are moved to next release - Triage tickets - - Review roadmap for next release -- (Marketing) Writes the "Highlights" section of the Changelog -- (PM) Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) + - Finalize roadmap for next release + - Draft roadmap for release after next (used to prioritize design tasks) +- (Marketing) Drafts marketing bullet points for next release based off of roadmap +- (Marketing) Submits pull request for "Highlights" section of the Changelog +- (Marketing) Notes date of announcements in release channel - (PM) Update [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) for any steps needed to upgrade to new version -- (PM) Prepare tickets for cutting RCs builds, filing issue in GitLab omnibus to take RC candidate, testing GitLab RC with Mattermost -- (Stand-up) Each team member discusses worst bug - -### - (8 weekdays before release date) Feature Complete and Stabilization -- After the cut-off time for Feature Complete, Dev prioritizes reviewing PRs and committing to master so Stabilization period can begin, with testing and high priority bug fixes -- During Stabilization period only BUGS can be committed to master, non-bug tickets are tagged for next version and wait until after a release candidate is cut to be added to master - - (PM) Review all [S1 bugs](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) and mark important ones as high priority - - (Dev + PM) Exceptions can be made by triage team consensus across PM and Dev. List of approved changes for release candidate 1 here: https://mattermost.atlassian.net/issues/?filter=10204 -- (PM) Documentation +- (PM) Prepare tickets for [cutting RC builds](https://mattermost.atlassian.net/browse/PLT-985), [creating the final release candidate](https://mattermost.atlassian.net/browse/PLT-986), [creating AMIs](https://mattermost.atlassian.net/browse/PLT-1213), and [testing GitLab RC with Mattermost](https://mattermost.atlassian.net/browse/PLT-1013) +- (Stand-up) Each team member discusses worst bug (10-15s) + +### (T-minus 8 working days) Feature Complete and Stabilization +- No pull requests for features can be submitted to the current release after this date (except if release manager add "release-exception" label to Jira ticket) +- (Ops) Post this checklist in Release channel +- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +- **Stablization** period begins when all features for release have been committed. + - During this period, only **bugs** can be committed to master. Non-bug pull requests are tagged for next version and wait until after a release candidate is cut to be committed to master + - (RM) Exceptions can be made by release manager by setting priority to "Highest" and labelling "release-exception", which will add ticket to [Hotfix list for release candidate](https://mattermost.atlassian.net/issues/?filter=10204). + - (PM) Review all [Severity 1 bugs (data loss or security)](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) to consider for adding to Hotfix list. +- (PM) Complete documentation - (PM) Make Changelog PR with updates for latest feature additions and changes - (PM) Make Changelog PR with updates to contributors - (PM) Make NOTICE.txt PR for any new libraries added from dev, if not added already - (PM) Prioritize any developer documentation tickets -- (PM and devs) Sign-off testing of their feature areas (i.e. PM/dev either signs-off that their area is well tested, or they flag that potential quality issues may exist) -- (Ops) Mail out mugs to any new contributors -- (Team) Select "Top Contributor" for the release from external contributions to be mentioned in release announcement -- (Marketing) Decides announce date (discuss in meeting) + - (PM) Draft [GitLab ticket](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/942) to take next Mattermost version in the Omnibus, but do not post until RC1 is cut +- (PM) Check testing is complete + - (PM) Works with Ops to check the [Quality Gate](https://github.com/mattermost/process/blob/master/release/quality-gates.md) for feature complete + - (PM + Dev) Sign-off testing of their feature areas (i.e. PM/dev either signs-off that their area is well tested, or they flag that potential quality issues may exist) +- **(Team) Feature Complete Meeting (10:15am PST)** + - (PM) Leads review of Changelog + - (Team) Each team member discusses worst bug (10-15s) + - (PM) Review feature list for next release + - (Marketing) Share draft of marketing announce for next release +- (Marketing) Communicates checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, - (Ops) Post Announce Date in Release channel + update the channel header to reflect date -- (Marketing) Communicates checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, documentation) and begins to write the blog post, tweet, and email for the release announcement -- (PM) Works with Ops to check the Quality Gate for feature complete -- (PM) Communicate to team the plan for next release -- (Stand-up) Each team member discusses worst bug +- (Ops) Mail out mugs to any new contributors -### - (5 weekdays before release date) Code Complete and Release Candidate Cut -- (Team) Meets to discuss release at 10am PST - - (PM) Each area changed in latest release is assigned a PM owner to lead testing - - (Ops) Walks through each item of the **Code Complete and Release Candidate Cut** checklist +### (T-minus 5 working days) Code Complete and Release Candidate Cut +- (Ops) Post this checklist in Release channel +- (Ops) For the next release, create team meetings on Feature Complete and Code Complete dates +- (PM) Remove "Under Development" notice for current release from Changelog on master +- **(Team) Code Complete Meeting (10:15am PST meeting)** + - (Ops) Walks through each item of this checklist + - (PM) Assigns each area of the release testing spreadsheet to a team member - (Dev) Last check of tickets that need to be merged before RC1 - - (Team) Each team member discusses worst bug -- After 10am PST meeting the release is considered “Code Complete”. - - (Dev) Completes final reviews and updates of PRs marked for the release version - - There should be no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release - - Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the Release Candidate Checklist + - (Team) Each team member discusses worst bug (10-15s) +- **Code Complete** is declared after meeting + - (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release + - (Build) Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the [Release Candidate Checklist](https://github.com/mattermost/process/blob/master/release/create-release-candidate.md) - (PM) Create meta issue for regressions in GitHub (see [example](https://github.com/mattermost/platform/issues/574)) - -### - (4 weekdays before release date) Release Candidate Testing -- Final testing is conducted by the team on the acceptance server and any issues found are filed - - (Dev) Tests upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) + - (PM) Include link to meta-issue in release notes of RC1 + - (PM) Tweet announcement that RC1 is ready (see [example](https://twitter.com/mattermosthq/status/664172166368264192)) + - (PM) Submit GitLab ticket to take next Mattermost version in the Omnibus + +### (T-minus 4 working days) Release Candidate Testing +- (Team) Final testing is conducted by the team on the acceptance server and any issues found are filed +- (Build) Tests upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) + - Database upgrade should be tested on both MySQL and Postgres - (Ops) Posts copy of the **Release Candidate Testing** checklist into Town Square in PRODUCTION - (Ops) Moves meeting, test and community channels over to the production version of RC, and posts in Town Square asking everyone to move communication over to the new team for testing purposes - (PM) Test feature areas and post bugs to Bugs/Issues in PRODUCTION @@ -72,6 +85,7 @@ This is a working document that will update as our process evolves. - (PM) Posts links to all issues found in RC as comments on the meta issue - (PM) Updates description to include approved fixes - (PM) Posts screenshot and link to final tickets for next RC to the Release room + - (PM) Updates Release Notes with any new issues that will not be fixed for the current version - (PM & DEV leads) Triage hotfix candidates and decide on whether and when to cut next RC or final - (Dev) PRs for hotfixes made to release branch, and changes from release branch are merged into master - (Ops) Tests approved fixes on master @@ -81,19 +95,28 @@ This is a working document that will update as our process evolves. - (Ops) verifies each of the issues in meta ticket is fixed - (PM) If no blocking issues are found, PM, Dev and Ops signs off on the release -### - (2 weekdays before release date) Release - - (Dev) Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC +### (T-minus 2 working days) Release Build Cut +- (Ops) Post this checklist in Release channel +- (Build) Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC - (PM) Any significant issues that were found and not fixed for the final release are noted in the release notes - - If an urgent and important issue needs to be addressed between major releases, a hotfix release (e.g. 1.1.1) may be released, however this should be very rare, given a monthly cadence - - (PM) Copy and paste the Release Notes from the Changelog to the Release Description - - (PM) Update the mattermost.org/download page - - (Dev) Delete RCs after final version is shipped - - (PM) Close final GitHub RC meta ticket - -### - (0 weekdays before release date) End of Release -- (PM) Makes sure marketing has been posted (animated GIFs, screenshots, mail announcement, Tweets, blog posts) + - If an urgent and important issue needs to be addressed between major releases, a bug fix release (e.g. 1.1.1) may be created +- (PM) Copy and paste the Release Notes from the Changelog to the Release Description +- (PM) Update the mattermost.org/download page +- (PM) Update the AMI links on mattermost.org/installation +- (PM) Close final GitHub RC meta ticket +- (Dev) Delete RCs after final version is shipped +- (Marketing) Finalize marketing + - (Marketing) Finalize mailchimp email blast + - (Marketing) Finalize blog post and put on timer for release + - (Marketing) Finalize tweet announcement + - (Marketing) Finalize announcement on general mailing list + - (Marketing) Finalize announcement for gitlab.mattermost.com + +### (T-minus 0 working days) Release Day +- (Ops) Post this checklist in Release channel +- (PM) Confirm marketing has been posted (animated GIFs, screenshots, mail announcement, Tweets, blog posts) - (PM) Close the release in Jira +- (PM) Set header of next release as UNDER DEVELOPMENT in CHANGELOG on master - (Dev) Check if any libraries need to be updated for the next release, and if so bring up in weekly team meeting -- (Ops) Post important dates for the next release in the header of the Release channel -- (Ops) Queue an agenda item for next team meeting for "Stepping Back" Q&A -- (Ops) Queue an agenda item for next team meeting for Roadmap review +- (Ops) Post key dates for the next release in the header of the Release channel +- (Ops) Queue an agenda item for next team meeting for Release Process Kaizen/Q&A |