summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorit33 <iantien@gmail.com>2015-11-13 00:25:38 -0800
committerit33 <iantien@gmail.com>2015-11-13 00:25:38 -0800
commit2c40f776f88b7e95dc568b0a0764c9e9237bf67f (patch)
treec18006b2b7bf523674df8c96dc5f6c161cb23b6f
parenteeb09a05c58f72ca42ab1d0ad1016e7e5da91c66 (diff)
parente24524a636792cafd69724ae0a0c6f7c180a824b (diff)
downloadchat-2c40f776f88b7e95dc568b0a0764c9e9237bf67f.tar.gz
chat-2c40f776f88b7e95dc568b0a0764c9e9237bf67f.tar.bz2
chat-2c40f776f88b7e95dc568b0a0764c9e9237bf67f.zip
Merge pull request #1421 from mattermost/help-docs-update
Docs update
-rw-r--r--doc/README.md8
-rw-r--r--doc/help/Manage-Members.md (renamed from doc/help/team-settings/Manage-Members.md)0
-rw-r--r--doc/help/Team-Settings.md70
-rw-r--r--doc/help/Team-Statistics.md24
-rw-r--r--doc/help/system-console/Team-Statistics.md24
-rw-r--r--doc/help/team-settings/General-Settings.md17
-rw-r--r--doc/help/team-settings/Slack-Import.md29
7 files changed, 99 insertions, 73 deletions
diff --git a/doc/README.md b/doc/README.md
index 5760a06d0..d062dee65 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -57,14 +57,16 @@ _Note: End user help documentation is a new feature being completed for the v1.2
- [Sign-in](help/Sign-in.md)
- User Interface
- - Team Settings
+ - 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)
- - [Slack Import](help/Slack-Import.md)
- Messaging
- [Mattermost Markdown Formatting](usage/Markdown.md)
- [Search](help/Search.md)
- System Console
- Team
- - [Team Statistics](help/Team-Statistics.md)
+ - [Team Statistics](help/system-console/Team-Statistics.md)
diff --git a/doc/help/team-settings/Manage-Members.md b/doc/help/Manage-Members.md
index 04243f9fb..04243f9fb 100644
--- a/doc/help/team-settings/Manage-Members.md
+++ b/doc/help/Manage-Members.md
diff --git a/doc/help/Team-Settings.md b/doc/help/Team-Settings.md
new file mode 100644
index 000000000..7e6cf5dd5
--- /dev/null
+++ b/doc/help/Team-Settings.md
@@ -0,0 +1,70 @@
+## Team Settings
+
+The Team Settings menu offers Team Administrators, Team Owners and System Administrators to adjust settings applying to a specific team.
+
+The following settings are found in a Team Site from the **Three-Dot** menu at the top of the left sidebar under **Team Settings**.
+
+### General
+
+General settings under the **Team Settings** > **General** configure how a team is displayed to users.
+
+#### Team Name
+
+Your **Team Name** is displayed on the sign-in page, and in the top of the left-hand sidebar for your team.
+
+#### Allow anyone to sign-up from login page
+
+Setting this option to **Yes** a link to the account creation page is included on the sign-in page of this team.
+
+Team Administrators would set this to **Yes** when they:
+ 1. Operate on a closed network and want to make sign-up easy.
+ 2. Operate on the open internet with sign-up restricted to specific domains, and want to allow easy sign-up from users with email addresses. Note: System Administrators can restrict sign-up to specific domains via the System Console.
+ 3. Operate on the open internet and want to allow anyone to sign-up.
+
+Team Administrators would set this to **No** when they:
+ 1. Operate on the open internet and want a small, private team that is email-invite-only
+
+#### Include this team in the Team Directory
+
+Setting this option to **Yes** includes the Team Name on the Home Page and a link to this team's sign-in page.
+
+Team Administrators would set this to **Yes** when they:
+ 1. Operate on a closed network and want to make it easy to discover their team from the Home Page of the Mattermost server.
+ 2. Operate on the open internet with sign-up restricted to specific domains, and want to allow easy sign-up from users with email addresses. Note: System Administrators can restrict sign-up to specific domains via the System Console.
+ 3. Operate on the open internet and want to allow anyone to sign-up to their team from the Home Page of the Mattermost server.
+
+Team Administrators would set this to **No** when they:
+ 1. Operate on the open internet and want a small, private team that is email-invite-only
+
+#### Invite Code
+
+When allowing anyone to sign-up from the login page, the **Invite Code** is used as part of the sign-up process. Clicking **Re-Generate** will invalidate the previous invitations and invitation URLs.
+
+### Import
+
+#### Import from Slack (Beta)
+
+*Note: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by [filing an issue](https://github.com/mattermost/platform/issues).*
+
+The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users. To use:
+
+1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**
+
+2. In Mattermost go to **Team Settings > Import > Import from Slack**. _Team Owner_ or _Team Administrator_ role is required to access this menu option.
+
+3. Click **Select file** to upload Slack export file and click **Import**.
+
+4. Emails and usernames from Slack are used to create new Mattermost accounts
+
+5. Slack users can activate their new Mattermost accounts by using Mattermost's Password Reset screen with their email addresses from Slack to set new passwords for their Mattermost accounts
+
+6. Once logged in, the Mattermost users will have access to previous Slack messages in the public channels imported from Slack.
+
+**It is highly recommended that you test Slack import before applying it to an instance intended for production.** If you use Docker, you can spin up a test instance in one line (`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`). If you don't use Docker, there are [step-by-step instructions](../install/Docker-Single-Container.md) to install Mattermost in preview mode in less than 5 minutes.
+
+#### Notes:
+
+- 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.
+- In Beta, Slack accounts with username or email address collisions with existing Mattermost accounts will not import and mentions do not resolve as Mattermost usernames (still shows Slack ID). No pre-check or roll-back is currently offered.
diff --git a/doc/help/Team-Statistics.md b/doc/help/Team-Statistics.md
deleted file mode 100644
index 05d63794b..000000000
--- a/doc/help/Team-Statistics.md
+++ /dev/null
@@ -1,24 +0,0 @@
-## Team Statistics
-___
-Statistics on users, posts and channels are tracked for each team and viewable in the System Console. System Administrators can access statistics for your Mattermost teams by clicking the **three-dot menu**, then click **System Console**. Under the *Teams* section on the left side you’ll see a list of the teams that belong to your domain. Click **Statistics** under the team of interest to open the stats page. Here is some helpful terminology:
-
-**Total Users**
-The total number of accounts created, regardless of if the accounts are active or inactive.
-
-**Total Posts**
-The total number of posts made by your team, including deleted posts or those made by incoming and outgoing webhook integrations.
-
-**Public Groups**
-The number of public channels created by your team, including channels that may have been archived.
-
-**Private Group**
-The number of private groups created by your team, including groups that may have been archived.
-
-**Active Users With Posts**
-Users who logged in and made a post on a certain day.
-
-**Recently Active Users**
-Users that have logged in and had recent browser activity in Mattermost.
-
-**Newly Created Users**
-Users that have recently completed the signup process to create a Mattermost account on the team.
diff --git a/doc/help/system-console/Team-Statistics.md b/doc/help/system-console/Team-Statistics.md
new file mode 100644
index 000000000..eef7b8346
--- /dev/null
+++ b/doc/help/system-console/Team-Statistics.md
@@ -0,0 +1,24 @@
+# Team Statistics
+
+Statistics on users, posts and channels are tracked for each team are viewable under **System Console** > **Teams** > **Statistics**.
+
+## Total Users
+The total number of accounts created, including both active and inactive accounts.
+
+## Total Posts
+The total number of posts made in a team, including deleted posts and posts made using automation.
+
+## Public Groups
+The number of public channels created by your team, including channels that may have been archived.
+
+## Private Group
+The number of private groups created by your team, including groups that may have been archived.
+
+## Active Users With Posts
+Users who logged in and made a post on a certain day.
+
+## Recently Active Users
+Users that have logged in and had recent browser activity in Mattermost.
+
+## Newly Created Users
+Users that have recently completed the sign-up process to create a Mattermost account on the team.
diff --git a/doc/help/team-settings/General-Settings.md b/doc/help/team-settings/General-Settings.md
deleted file mode 100644
index a35e29df3..000000000
--- a/doc/help/team-settings/General-Settings.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# General Team Settings
-
-## Team Name
-
-Your **Team Name** is displayed on the sign-in page, and in the top of the left-hand sidebar for your team.
-
-## Allow anyone to sign-up from login page
-
-Setting this option to **Yes** a link to the account creation page is included on the sign-in page of this team.
-
-## Include this team in the Team Directory
-
-Setting this option to **Yes** includes the Team Name on the Home Page and a link to this team's sign-in page.
-
-## Invite Code
-
-When allowing anyone to sign-up from the login page, the **Invite Code** is used as part of the sign-up process. Clicking **Re-Generate** will invalidate the previous invitations and invitation URLs.
diff --git a/doc/help/team-settings/Slack-Import.md b/doc/help/team-settings/Slack-Import.md
deleted file mode 100644
index f834d5177..000000000
--- a/doc/help/team-settings/Slack-Import.md
+++ /dev/null
@@ -1,29 +0,0 @@
-### Slack Import
-
-*Note: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by [filing an issue](https://github.com/mattermost/platform/issues).*
-
-#### Usage
-
-The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users. To use:
-
-1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**
-
-2. In Mattermost go to **Team Settings > Import > Import from Slack**. _Team Owner_ or _Team Administrator_ role is required to access this menu option.
-
-3. Click **Select file** to upload Slack export file and click **Import**.
-
-4. Emails and usernames from Slack are used to create new Mattermost accounts
-
-5. Slack users can activate their new Mattermost accounts by using Mattermost's Password Reset screen with their email addresses from Slack to set new passwords for their Mattermost accounts
-
-6. Once logged in, the Mattermost users will have access to previous Slack messages in the public channels imported from Slack.
-
-**It is highly recommended that you test Slack import before applying it to an instance intended for production.** If you use Docker, you can spin up a test instance in one line (`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`). If you don't use Docker, there are [step-by-step instructions](../install/Docker-Single-Container.md) to install Mattermost in preview mode in less than 5 minutes.
-
-#### Notes:
-
-- 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.
-- In Beta, Slack accounts with username or email address collisions with existing Mattermost accounts will not import and mentions do not resolve as Mattermost usernames (still shows Slack ID). No pre-check or roll-back is currently offered.
-