diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/API.md | 2 | ||||
| -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 | 192 | ||||
| -rw-r--r-- | doc/developer/tests/test-markdown.md | 25 | ||||
| -rw-r--r-- | doc/help/Sign-in.md | 6 | ||||
| -rw-r--r-- | doc/install/Configuration-Settings.md | 10 | ||||
| -rw-r--r-- | doc/install/Troubleshooting.md | 2 | ||||
| -rw-r--r-- | doc/integrations/Single-Sign-On/GitHub-Enterprise.md | 20 | ||||
| -rw-r--r-- | doc/integrations/Single-Sign-On/GitHub.md | 24 | ||||
| -rw-r--r-- | doc/process/overview.md | 2 |
11 files changed, 406 insertions, 34 deletions
diff --git a/doc/developer/API.md b/doc/developer/API.md index 1be3669ab..1da1a475b 100644 --- a/doc/developer/API.md +++ b/doc/developer/API.md @@ -40,7 +40,7 @@ If you're building a deep integration with Mattermost, for example a mobile nati If no driver is available for the programming language of your choice, you can view the [Golang Driver](https://github.com/mattermost/platform/blob/master/model/client.go) source code to understand how it exercises the Web Service API. You can also learn more by reviewing open source projects that use the Web Service API, like [matterircd](https://github.com/42wim/matterircd). -There are a wide range of [installation guides](www.mattermost.org/installation/) for setting up your own Mattermost server on which to develop and test your integrations. +There are a wide range of [installation guides](http://www.mattermost.org/installation/) for setting up your own Mattermost server on which to develop and test your integrations. 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..905350d31 --- /dev/null +++ b/doc/developer/tests/test-markdown-lists.md @@ -0,0 +1,192 @@ +# 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 + 2. 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 + +### Carriage Return and New Line After a List + +**Expected:** +``` +1. One + - Two +This text should be on a new line. +``` + +**Actual:** +1. One + - Two +This text should be on a new line. + 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/Sign-in.md b/doc/help/Sign-in.md index 728a7d42c..f8e353cce 100644 --- a/doc/help/Sign-in.md +++ b/doc/help/Sign-in.md @@ -12,8 +12,12 @@ If you have forgotten your password, you should be able to reset it from the "I #### 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. +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. #### 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. + +#### 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. diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index 44730d40f..66fda15e0 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -268,19 +268,19 @@ Settings to configure account and team creation using GitLab OAuth. “true”: Allow team creation and account signup using GitLab OAuth. To configure, input the **Secret** and **Id** credentials. ```"Secret": ""``` -Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs `https://<your-mattermost-url>/login/gitlab/complete` (example: `https://example.com:8065/login/gitlab/complete`) and `https://<your-mattermost-url>/signup/gitlab/complete`. ```"Id": ""``` -Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs `https://<your-mattermost-url>/login/gitlab/complete` (example: `https://example.com:8065/login/gitlab/complete`) and `https://<your-mattermost-url>/signup/gitlab/complete`. ```"AuthEndpoint": ""``` -Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/authorize). Use HTTP or HTTPS depending on how your server is configured. +Enter `https://<your-gitlab-url>/oauth/authorize` (example: `https://example.com:3000/oauth/authorize`). Use HTTP or HTTPS depending on how your server is configured. ```"TokenEndpoint": ""``` -Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/token). Use HTTP or HTTPS depending on how your server is configured. +Enter `https://<your-gitlab-url>/oauth/authorize` (example: `https://example.com:3000/oauth/token`). Use HTTP or HTTPS depending on how your server is configured. ```"UserApiEndpoint": ""``` -Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/api/v3/user). Use HTTP or HTTPS depending on how your server is configured. +Enter `https://<your-gitlab-url>/oauth/authorize` (example: `https://example.com:3000/api/v3/user`). Use HTTP or HTTPS depending on how your server is configured. ## Config.json Settings Not in System Console diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 78ab5617d..deae7717d 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -22,7 +22,7 @@ The following is a list of common error messages and solutions: ###### `x509: certificate signed by unknown authority` in server logs when attempting to sign-up - - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. You + - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. - **Solution:** Set up a load balancer like Ngnix [per production install guide](https://github.com/mattermost/platform/blob/master/doc/install/Production-Ubuntu.md#set-up-nginx-with-ssl-recommended). A ticket exists to [add support for self-signed certificates in future](x509: certificate signed by unknown authority). ###### `panic: runtime error: invalid memory address or nil pointer dereference` diff --git a/doc/integrations/Single-Sign-On/GitHub-Enterprise.md b/doc/integrations/Single-Sign-On/GitHub-Enterprise.md new file mode 100644 index 000000000..6f6633846 --- /dev/null +++ b/doc/integrations/Single-Sign-On/GitHub-Enterprise.md @@ -0,0 +1,20 @@ +## Configuring GitHub Enterprise Single-Sign-On (unofficial) + +Note: Because the authentication interface of GitHub Enterprise is similar to that of GitLab, the GitLab SSO feature can be used to unofficially also support GitHub Enterprise SSO. + +Follow these steps to configure Mattermost to use Github Enterprise as a single-sign-on (SSO) service for team creation, account creation and sign-in using the GitLab SSO interface. + +1. Login to your GitHub Enterprise account and go to the Applications section in Profile Settings. +2. Add a new application called "Mattermost" with the following as Authorization callback URL: + * `<your-mattermost-url>` (example: http://localhost:8065) + +3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _GitLabSettings_ fields in config/config.json + +4. Also in config/config.json, set _Enable_ to `true` for the _gitlab_ section, leave _Scope_ blank and use the following for the endpoints: + * _AuthEndpoint_: `https://<your-github-enterprise-url>/oauth/authorize` (example https://github.com/oauth/authorize) + * _TokenEndpoint_: `https://<your-github-enterprise-url>/oauth/access_token` + * _UserApiEndpoint_: `https://<your-github-enterprise-url>/api/v3/user` + +5. (Optional) If you would like to force all users to sign-up with GitHub Enterprise only, in the _ServiceSettings_ section of config/config.json set _DisableEmailSignUp_ to `true`. + +6. Restart your Mattermost server to see the changes take effect. diff --git a/doc/integrations/Single-Sign-On/GitHub.md b/doc/integrations/Single-Sign-On/GitHub.md new file mode 100644 index 000000000..56e2d1c72 --- /dev/null +++ b/doc/integrations/Single-Sign-On/GitHub.md @@ -0,0 +1,24 @@ +## Configuring GitHub Single-Sign-On (unofficial) + +Note: Because the authentication interface of GitHub is similar to that of GitLab, the GitLab SSO feature can be used to unofficially also support GitHub SSO. + +Follow these steps to configure Mattermost to use Github as a single-sign-on (SSO) service for team creation, account creation and sign-in using the GitLab SSO interface. + +1. Login to your GitHub account and go to the Applications section in Profile Settings. +2. Add a new application called "Mattermost" with the following as Authorization callback URL: + * `<your-mattermost-url>` (example: http://localhost:8065) + +3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _GitLabSettings_ fields in config/config.json + +4. Also in config/config.json, set _Enable_ to `true` for the _gitlab_ section, leave _Scope_ blank and use the following for the endpoints: + * _AuthEndpoint_: `https://github.com/login/oauth/authorize` + * _TokenEndpoint_: `https://github.com/login/oauth/access_token` + * _UserApiEndpoint_: `https://api.github.com/user` + +6. (Optional) If you would like to force all users to sign-up with GitHub only, +in the _ServiceSettings_ section of config/config.json set _DisableEmailSignUp_ +to `true`. + +6. Restart your Mattermost server to see the changes take effect. + +7. Tell the users to set their public email for GitHub at the [Public profile page](https://github.com/settings/profile). Mattermost uses the email to create account. diff --git a/doc/process/overview.md b/doc/process/overview.md index b34908782..a1201a8d6 100644 --- a/doc/process/overview.md +++ b/doc/process/overview.md @@ -40,7 +40,7 @@ A system primarily used by Mattermost for reporting bugs with clear statements o See [Filing Issues](http://www.mattermost.org/filing-issues/) for details on how to file issues for Mattermost in GitHub. -For feature ideas, troubleshooting, or general questions, we ask your help to use the appropriate [Community System](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#community-systems). +Please consider using more mainstream processes for [filing feature ideas to be upvoted](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#feature-idea-forum), to ask [troubleshooting questions](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#troubleshooting-forum), or [general questions](https://github.com/mattermost/platform/blob/master/doc/process/overview.md#general-forum). ### GitHub Pull Requests |