summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoram Wilander <jwawilander@gmail.com>2015-10-12 12:06:55 -0400
committerJoram Wilander <jwawilander@gmail.com>2015-10-12 12:06:55 -0400
commit4949b6837f1a2ef103f58659c7692f01378128f7 (patch)
tree5d53313029624492c15888345167a4146d1ea918 /doc
parent6aff5900f79721783599a7ab9fe29074e4050544 (diff)
parentf55416d9f45afcb310246426366cd261f138029f (diff)
downloadchat-4949b6837f1a2ef103f58659c7692f01378128f7.tar.gz
chat-4949b6837f1a2ef103f58659c7692f01378128f7.tar.bz2
chat-4949b6837f1a2ef103f58659c7692f01378128f7.zip
Merge branch 'master' into typos
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md6
-rw-r--r--doc/api/Overview.md2
-rw-r--r--doc/developer/Code-Contribution-Guidelines.md3
-rw-r--r--doc/help/Slack-Import.md (renamed from doc/usage/Slack-Import.md)6
-rw-r--r--doc/install/Release-Numbering.md2
5 files changed, 10 insertions, 9 deletions
diff --git a/doc/README.md b/doc/README.md
index a45b670c0..fcda4fd08 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -26,14 +26,16 @@ Set up Mattermost in your data center
- [Developer Machine Setup](developer/Setup.md)
- [Mattermost Style Guide](developer/Style-Guide.md)
- [API Overview](api/Overview.md)
- - [Incoming Webhooks](integrations/webhooks/Incoming.md)
+ - [Incoming Webhooks](integrations/webhooks/Incoming-Webhooks.md)
## Help
+_Note: End user help documentation is a new feature being completed for the v1.2 release. The materials below are work in progress._
+
- User Interface
- [Manage Team](help/Manage-Team.md)
- Team Settings
- - [Slack Import](usage/Slack-Import.md)
+ - [Slack Import](help/Slack-Import.md)
- Messaging
- [Mattermost Markdown Formatting](usage/Markdown.md)
diff --git a/doc/api/Overview.md b/doc/api/Overview.md
index 02e11974e..0a407b1e9 100644
--- a/doc/api/Overview.md
+++ b/doc/api/Overview.md
@@ -77,7 +77,7 @@ X-Ratelimit-Reset: 1441983590
These headers are telling you your current rate limit status.
Header | Description
---------------------- | -----------
+:--------------------- |:-----------
X-Ratelimit-Limit | The maximum number of requests you can make per second.
X-Ratelimit-Remaining | The number of requests remaining in the current window.
X-Ratelimit-Reset | The remaining UTC epoch seconds before the rate limit resets.
diff --git a/doc/developer/Code-Contribution-Guidelines.md b/doc/developer/Code-Contribution-Guidelines.md
index 80676f107..363934818 100644
--- a/doc/developer/Code-Contribution-Guidelines.md
+++ b/doc/developer/Code-Contribution-Guidelines.md
@@ -5,7 +5,6 @@ Thank you for your interest in contributing to Mattermost. This guide provides a
## Choose a Ticket
1. Review the list of [Good First Contribution](https://mattermost.atlassian.net/issues/?filter=10206) tickets listed in Jira.
-
2. These projects are intended to be a straight forward first pull requests from new contributors.
If you don't find something appropriate for your interests, please see the full list of tickets [Accepting Pull Requests](https://mattermost.atlassian.net/issues/?filter=10101).
@@ -13,7 +12,7 @@ If you don't find something appropriate for your interests, please see the full
## Install Mattermost and set up a Fork
-1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/install/dev-setup.md) to install Mattermost.
+1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/developer/Setup.md) to install Mattermost.
2. Create a branch with <branch name> set to the ID of the ticket you're working on, for example ```PLT-394```, using command:
diff --git a/doc/usage/Slack-Import.md b/doc/help/Slack-Import.md
index c30de0567..a3b672b04 100644
--- a/doc/usage/Slack-Import.md
+++ b/doc/help/Slack-Import.md
@@ -1,8 +1,8 @@
-#### Slack Import (Preview)
+#### Slack Import (Beta)
*Note: As a SaaS service, Slack is able to change its export format quickly. If you encounter issues not mentioned in the documentation below, please let us know by [filing an issue](https://github.com/mattermost/platform/issues).*
-The Slack Import feature in Mattermost is in "Preview" and focus is on supporting migration of teams of less than 100 registered users. The feature can be accessed from by Team Administrators and Team Owners via the `Team Settings -> Import` menu option.
+The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users. The feature can be accessed from by Team Administrators and Team Owners via the `Team Settings -> Import` menu option.
Mattermost currently supports the processing of an "Export" file from Slack containing account information and public channel archives from a Slack team.
@@ -14,5 +14,5 @@ Limitations:
- Newly added markdown suppport in Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported.
- Slack does not export files or images your team has stored in Slack's database. Mattermost will provide links to the location of your assets in Slack's web UI.
- Slack does not export any content from private groups or direct messages that your team has stored in Slack's database.
-- The Preview release of Slack Import does not offer pre-checks or roll-back and will not import Slack accounts with username or email address collisions with existing Mattermost accounts. Also, Slack channel names with underscores will not import. Also, mentions do not yet resolve as Mattermost usernames (still show Slack ID).
+- The Preview release of Slack Import does not offer pre-checks or roll-back and will not import Slack accounts with username or email address collisions with existing Mattermost accounts. Also, Slack channel names with underscores will not import. Also, mentions do not yet resolve as Mattermost usernames (still shows Slack ID).
diff --git a/doc/install/Release-Numbering.md b/doc/install/Release-Numbering.md
index 71374f7ef..3b0391cff 100644
--- a/doc/install/Release-Numbering.md
+++ b/doc/install/Release-Numbering.md
@@ -14,4 +14,4 @@ Major Build Number:
Minor Build Number:
-- Indicates bugfix/security releases (e.g. 1.2.5, 1.2.6)
+- Indicates a bug fix or security release (e.g. 1.2.5, 1.2.6)