diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/Setup.md | 51 | ||||
| -rw-r--r-- | doc/developer/tests/test-syntax-highlighting.md | 2 | ||||
| -rw-r--r-- | doc/help/Markdown.md | 2 | ||||
| -rw-r--r-- | doc/help/Messaging.md | 34 | ||||
| -rw-r--r-- | doc/help/Sign-in.md | 2 |
5 files changed, 69 insertions, 22 deletions
diff --git a/doc/developer/Setup.md b/doc/developer/Setup.md index 24e7d6a90..fd3704545 100644 --- a/doc/developer/Setup.md +++ b/doc/developer/Setup.md @@ -58,8 +58,7 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org 1. `mkdir ~/go` 2. Add the following to your ~/.bashrc `export GOPATH=$HOME/go` - `export GOROOT=/usr/local/go` - `export PATH=$PATH:$GOROOT/bin` + `export PATH=$PATH:$GOPATH/bin` `ulimit -n 8096` If you don't increase the file handle limit you may see some weird build issues with browserify or npm. 3. Reload your bashrc @@ -81,3 +80,51 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org 10. 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 + +### Archlinux ### + +1. Install Docker + 1. `pacman -S docker` + 2. `gpasswd -a user docker` + 3. `systemctl enable docker.service` + 4. `systemctl start docker.service` + 5. `newgrp docker` +2. Set up your dockerhost address + 1. Edit your /etc/hosts file to include the following line + `127.0.0.1 dockerhost` +3. Install Go + 1. `pacman -S go` +4. Set up your Go workspace and add Go to the PATH + 1. `mkdir ~/go` + 2. Add the following to your ~/.bashrc + 1. `export GOPATH=$HOME/go` + 2. `export GOROOT=/usr/lib/go` + 3. `export PATH=$PATH:$GOROOT/bin` + 3. Reload your bashrc + `source ~/.bashrc` +4. Edit /etc/security/limits.conf and add the following lines (replace *username* with your user): + + ``` + username soft nofile 8096 + username hard nofile 8096 + ``` + + You will need to reboot after changing this. If you don't increase the file handle limit you may see some weird build issues with browserify or npm. +5. Install Node.js + `pacman -S nodejs npm` +6. Install Ruby and Compass + 1. `pacman -S ruby` + 2. Add executable gems to your path in your ~/.bashrc + + `PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"` + 3. `gem install compass` +7. 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` +8. Run unit tests on Mattermost using `make test` to make sure the installation was successful +9. 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 diff --git a/doc/developer/tests/test-syntax-highlighting.md b/doc/developer/tests/test-syntax-highlighting.md index 7f8f4cdaa..b1568c385 100644 --- a/doc/developer/tests/test-syntax-highlighting.md +++ b/doc/developer/tests/test-syntax-highlighting.md @@ -133,7 +133,7 @@ echo "Hello World" ### CoffeeScript -``` coffee +``` coffeescript console.log(“Hello world!”); ``` diff --git a/doc/help/Markdown.md b/doc/help/Markdown.md index 64ce4fc83..d185a4160 100644 --- a/doc/help/Markdown.md +++ b/doc/help/Markdown.md @@ -31,7 +31,7 @@ code block 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` +`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffeescript, cs (C#), cpp (C++), sql, go, ruby, java, ini, latex` Example: diff --git a/doc/help/Messaging.md b/doc/help/Messaging.md index 548892650..2063ad41c 100644 --- a/doc/help/Messaging.md +++ b/doc/help/Messaging.md @@ -1,18 +1,18 @@ # Messaging -## Writing Messages +### Writing Messages -You can write messages using the input box with the text "Write a message..." at the bottom of Mattermost. +You can write messages using the input box with the text "Write a message..." at the bottom of Mattermost. -Press **ENTER** to send a message. Use **Shift+ENTER** to create a new line without sending a message. +Press **ENTER** to send a message. Use **Shift+ENTER** to create a new line without sending a message. -## Formatting Messages +### Formatting Messages -Mattermost messages are formatted using a standard called "markdown". Here are examples: +Mattermost messages are formatted using a standard called "markdown". Here are examples: | Text Entered | How it appears | |:---------------|:---------------| -|`**bold**`| **bold** | +|`**bold**`| **bold** | | `_italic_`|_italic_| |`[hyperlink](http://mattermost.org)`|[hyperlink](http://mattermost.org)| |``|| @@ -21,27 +21,27 @@ Mattermost messages are formatted using a standard called "markdown". Here are e Emojis provided free from [Emoji One](http://emojione.com/). Check out a full list of Emojis [here](http://emoji.codes/). -## Mentioning Teammates +### Mentioning Teammates -You can mention a teammate by using the `@` symbol plus their username to send them a special notification to draw their attention. +You can mention a teammate by using the `@` symbol plus their username to send them a special notification to draw their attention. -For example, you might write: +For example, you might write: ``` @alice how did your interview go with the new candidate? -``` +``` -Which sends a special mention notification to **alice** to check your message. +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. +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** +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 +### 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: +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. +- **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/Sign-in.md b/doc/help/Sign-in.md index 5b7b375c7..3b91af1fc 100644 --- a/doc/help/Sign-in.md +++ b/doc/help/Sign-in.md @@ -24,4 +24,4 @@ If your account in a given team has been given the System Administrator role, it #### 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-in to that share the same email address. +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 teams that are signed-in and open in your browser. |