diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 20 | ||||
| -rw-r--r-- | doc/help/Markdown.md | 180 | ||||
| -rw-r--r-- | doc/help/README.md | 18 | ||||
| -rw-r--r-- | doc/integrations/Single-Sign-On/Gitlab.md | 2 | ||||
| -rw-r--r-- | doc/process/overview.md | 2 | ||||
| -rw-r--r-- | doc/usage/Markdown.md | 179 |
6 files changed, 201 insertions, 200 deletions
diff --git a/doc/README.md b/doc/README.md index d062dee65..15d1d731b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -51,22 +51,4 @@ Procedures for upgrading the Mattermost server ## Help -_Note: End user help documentation is a new feature being completed for the v1.2 release. The materials below are work in progress._ - -- Getting Started - - [Sign-in](help/Sign-in.md) - -- 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) - - [Manage Members](help/Manage-Members.md) - - Messaging - - [Mattermost Markdown Formatting](usage/Markdown.md) - - [Search](help/Search.md) - -- System Console - - Team - - [Team Statistics](help/system-console/Team-Statistics.md) - +See [End User Help](help/README.md). diff --git a/doc/help/Markdown.md b/doc/help/Markdown.md new file mode 100644 index 000000000..1befed8d4 --- /dev/null +++ b/doc/help/Markdown.md @@ -0,0 +1,180 @@ +# Markdown Help + +Markdown makes it easy to format messages. Type a message as you normally would, and use these rules to render it with special formatting. + +## Text Style: + +You can use either `_` or `*` around a word to make it italic. Use two to make it bold. + +* `_italics_` renders as _italics_ +* `**bold**` renders as **bold** +* `**_bold-italic_**` renders as **_bold-italics_** +* `~~strikethrough~~` renders as ~~strikethrough~~ + +## Code Block: + +Create a code block by indenting each line by four spaces, or by placing ``` on the line above and below your code. + +Example: + + ``` + code block + ``` + +Renders as: +``` +code block +``` + +### Syntax Highlighting + +To add syntax highlighting, type the language to be highlighted after the ``` at the beginning of the code block. + +Supported languages are: +`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffee (CoffeeScript), cs (C#), cpp (C++), sql, go, ruby, java, ini, latex` + +Example: + + ``` go + package main + import "fmt" + func main() { + fmt.Println("Hello, 世界") + } + ``` + +Renders as: +``` go +package main +import "fmt" +func main() { + fmt.Println("Hello, 世界") +} +``` + +## In-line Code: + +Create in-line monospaced font by surrounding it with backticks. +``` +`monospace` +``` +Renders as: `monospace`. + +## Links: + +Create labeled links by putting the desired text in square brackets and the associated link in normal brackets. + +`[Check out Mattermost!](www.mattermost.com)` + +Renders as: [Check out Mattermost!](www.mattermost.com) + +## In-line Images + +Create in-line images using an `!` followed by the alt text in square brackets and the link in normal brackets. Add hover text by placing it in quotes after the link. +``` + + +and + +[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform) +``` +Renders as: + + + +and + +[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform) + +## Emojis + +Check out a full list of emojis [here](http://www.emoji-cheat-sheet.com/). + +``` +:smile: :+1: :sheep: +``` +Renders as: +:smile: :+1: :sheep: + +## Lines: + +Create a line by using three `*`, `_`, or `-`. + +`***` renders as: +*** + +## Block quotes: + +Create block quotes using `>`. + +`> block quotes` renders as: +> block quotes + +## Lists: + +Create a list by using `*` or `-` as bullets. Indent a bullet point by adding two spaces in front of it. +``` +* list item one +* list item two + * item two sub-point +``` +Renders as: +* list item one +* list item two + * item two sub-point + +Make it an ordered list by using numbers instead: +``` +1. Item one +2. Item two +``` +Renders as: +1. Item one +2. Item two + +## 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. +``` +| Left-Aligned | Center Aligned | Right Aligned | +| :------------ |:---------------:| -----:| +| Left column 1 | this text | $100 | +| Left column 2 | is | $10 | +| Left column 3 | centered | $1 | +``` + +Renders as: + +| Left-Aligned | Center Aligned | Right Aligned | +| :------------ |:---------------:| -----:| +| Left column 1 | this text | $100 | +| Left column 2 | is | $10 | +| Left column 3 | centered | $1 | + +## Headings: + +Make a heading by typing # and a space before your title. For smaller headings, use more #’s. +``` +# Large heading +## Smaller heading +### Even smaller heading +``` +Renders as: +# Large Heading +## Smaller Heading +### Even smaller heading + +Alternatively, for the large heading you can underline the text using `===`. For the smaller heading you can underline using `---` +``` +Large Heading +============= + +Smaller Heading +-------------- +``` +Renders as: +Large Heading +============= + +Smaller Heading +-------------- diff --git a/doc/help/README.md b/doc/help/README.md new file mode 100644 index 000000000..3b3c1709b --- /dev/null +++ b/doc/help/README.md @@ -0,0 +1,18 @@ +## Help + +- Getting Started + - [Sign-in](Sign-in.md) + +- 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) + - [Manage Members](Manage-Members.md) + - Messaging + - [Mattermost Markdown Formatting](help/Markdown.md) + - [Search](Search.md) + +- System Console + - Team + - [Team Statistics](system-console/Team-Statistics.md) diff --git a/doc/integrations/Single-Sign-On/Gitlab.md b/doc/integrations/Single-Sign-On/Gitlab.md index 1242fd13e..f0acc0e66 100644 --- a/doc/integrations/Single-Sign-On/Gitlab.md +++ b/doc/integrations/Single-Sign-On/Gitlab.md @@ -9,7 +9,7 @@ Follow these steps to configure Mattermost to use GitLab as a single-sign-on (SS (Note: If your GitLab instance is set up to use SSL, your URIs must begin with https://. Otherwise, use http://). -3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _SSOSettings_ fields in config/config.json +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-gitlab-url>/oauth/authorize` (example https://example.com/oauth/authorize) diff --git a/doc/process/overview.md b/doc/process/overview.md index ca15de3a7..8109163d9 100644 --- a/doc/process/overview.md +++ b/doc/process/overview.md @@ -136,8 +136,6 @@ Examples: - [Do not clear LastActivityAt for GetProfiles #1396](https://github.com/mattermost/platform/pull/1396/files) - [Update to proxy_pass #1331](https://github.com/mattermost/platform/pull/1331) -In general, it's - ## Release Mattermost ships stable releases on the 16th of the month. Releases begin with a planning process reviewing internal designs and community feedback in the context of the product purpose. Feature development is done in weekly sprints, and releases end with feature complete, stablization, code complete and release candidate milestones prior to final release. diff --git a/doc/usage/Markdown.md b/doc/usage/Markdown.md index dd90ede19..65e6f2121 100644 --- a/doc/usage/Markdown.md +++ b/doc/usage/Markdown.md @@ -1,180 +1,3 @@ # Markdown Help -Markdown makes it easy to format messages. Type a message as you normally would, and use these rules to render it with special formatting. - -## Text Style: - -You can use either `_` or `*` around a word to make it italic. Use two to make it bold. - -* `_italics_` renders as _italics_ -* `**bold**` renders as **bold** -* `**_bold-italic_**` renders as **_bold-italics_** -* `~~strikethrough~~` renders as ~~strikethrough~~ - -## Code Block: - -Create a code block by indenting each line by four spaces, or by placing ``` on the line above and below your code. - -Example: - - ``` - code block - ``` - -Renders as: -``` -code block -``` - -### Syntax Highlighting - -To add syntax highlighting, type the language to be highlighted after the ``` at the beginning of the code block. - -Supported languages are: -`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffee (CoffeeScript), cs (C#), cpp (C++), sql, go, ruby, java, ini, latex` - -Example: - - ``` go - package main - import "fmt" - func main() { - fmt.Println("Hello, 世界") - } - ``` - -Renders as: -``` go -package main -import "fmt" -func main() { - fmt.Println("Hello, 世界") -} -``` - -## In-line Code: - -Create in-line monospaced font by surrounding it with backticks. -``` -`monospace` -``` -Renders as: `monospace`. - -## Links: - -Create labeled links by putting the desired text in square brackets and the associated link in normal brackets. - -`[Check out Mattermost!](www.mattermost.com)` - -Renders as: [Check out Mattermost!](www.mattermost.com) - -## In-line Images - -Create in-line images using an `!` followed by the alt text in square brackets and the link in normal brackets. Add hover text by placing it in quotes after the link. -``` - - -and - -[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform) -``` -Renders as: - - - -and - -[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform) - -## Emojis - -Check out a full list of emojis [here](http://www.emoji-cheat-sheet.com/). - -``` -:smile: :+1: :sheep: -``` -Renders as: -:smile: :+1: :sheep: - -## Lines: - -Create a line by using three `*`, `_`, or `-`. - -`***` renders as: -*** - -## Block quotes: - -Create block quotes using `>`. - -`> block quotes` renders as: -> block quotes - -## Lists: - -Create a list by using `*` or `-` as bullets. Indent a bullet point by adding two spaces in front of it. -``` -* list item one -* list item two - * item two sub-point -``` -Renders as: -* list item one -* list item two - * item two sub-point - -Make it an ordered list by using numbers instead: -``` -1. Item one -2. Item two -``` -Renders as: -1. Item one -2. Item two - -## 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. -``` -| Left-Aligned | Center Aligned | Right Aligned | -| :------------ |:---------------:| -----:| -| Left column 1 | this text | $100 | -| Left column 2 | is | $10 | -| Left column 3 | centered | $1 | -``` - -Renders as: - -| Left-Aligned | Center Aligned | Right Aligned | -| :------------ |:---------------:| -----:| -| Left column 1 | this text | $100 | -| Left column 2 | is | $10 | -| Left column 3 | centered | $1 | - -## Headings: - -Make a heading by typing # and a space before your title. For smaller headings, use more #’s. -``` -# Large heading -## Smaller heading -### Even smaller heading -``` -Renders as: -# Large Heading -## Smaller Heading -### Even smaller heading - -Alternatively, for the large heading you can underline the text using `===`. For the smaller heading you can underline using `---` -``` -Large Heading -============= - -Smaller Heading --------------- -``` -Renders as: -Large Heading -============= - -Smaller Heading --------------- +Moved to [help/Markdown.md](../help/Markdown.md) |