From 05ebd8afdcfd3f584a0281c8ecef6878ea1d0b21 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 18:44:54 -0800 Subject: [PATCH 01/12] Rename doc/help/team-settings/Manage-Members.md to doc/help/Manage-Members.md --- doc/help/{team-settings => }/Manage-Members.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/help/{team-settings => }/Manage-Members.md (100%) diff --git a/doc/help/team-settings/Manage-Members.md b/doc/help/Manage-Members.md similarity index 100% rename from doc/help/team-settings/Manage-Members.md rename to doc/help/Manage-Members.md From 06ec8dd96aa4096554e6995871d1b0a13ba3240c Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 18:45:31 -0800 Subject: [PATCH 02/12] Rename doc/help/Team-Statistics.md to doc/help/system-console/Team-Statistics.md --- doc/help/{ => system-console}/Team-Statistics.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/help/{ => system-console}/Team-Statistics.md (100%) diff --git a/doc/help/Team-Statistics.md b/doc/help/system-console/Team-Statistics.md similarity index 100% rename from doc/help/Team-Statistics.md rename to doc/help/system-console/Team-Statistics.md From d11642574066e6f87519dc7a4cc078ef4be41c83 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 18:46:22 -0800 Subject: [PATCH 03/12] Update Team-Statistics.md --- doc/help/system-console/Team-Statistics.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/help/system-console/Team-Statistics.md b/doc/help/system-console/Team-Statistics.md index 05d63794bf..a1f5e2f07d 100644 --- a/doc/help/system-console/Team-Statistics.md +++ b/doc/help/system-console/Team-Statistics.md @@ -1,24 +1,24 @@ -## Team Statistics -___ +# 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** +## Total Users The total number of accounts created, regardless of if the accounts are active or inactive. -**Total Posts** +## 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** +## Public Groups The number of public channels created by your team, including channels that may have been archived. -**Private Group** +## Private Group The number of private groups created by your team, including groups that may have been archived. -**Active Users With Posts** +## Active Users With Posts Users who logged in and made a post on a certain day. -**Recently Active Users** +## Recently Active Users Users that have logged in and had recent browser activity in Mattermost. -**Newly Created Users** +## Newly Created Users Users that have recently completed the signup process to create a Mattermost account on the team. From 625c4f432015ddde4634c7723d1aeb9b2ac05f0e Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:10:45 -0800 Subject: [PATCH 04/12] Update Team-Statistics.md --- doc/help/system-console/Team-Statistics.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/help/system-console/Team-Statistics.md b/doc/help/system-console/Team-Statistics.md index a1f5e2f07d..eef7b83462 100644 --- a/doc/help/system-console/Team-Statistics.md +++ b/doc/help/system-console/Team-Statistics.md @@ -1,12 +1,12 @@ # 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: +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, regardless of if the accounts are active or inactive. +The total number of accounts created, including both active and inactive accounts. ## Total Posts -The total number of posts made by your team, including deleted posts or those made by incoming and outgoing webhook integrations. +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. @@ -21,4 +21,4 @@ Users who logged in and made a post on a certain day. 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. +Users that have recently completed the sign-up process to create a Mattermost account on the team. From 25f3c08f88c16b5ebf352571dcaea828138e74b5 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:12:57 -0800 Subject: [PATCH 05/12] Update README.md --- doc/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 5760a06d00..1ac2e6fbcb 100644 --- a/doc/README.md +++ b/doc/README.md @@ -59,12 +59,12 @@ _Note: End user help documentation is a new feature being completed for the v1.2 - User Interface - Team Settings - [Manage Members](help/Manage-Members.md) - - [Slack Import](help/Slack-Import.md) + - [Slack Import](help/team-settings/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) From 5764ba8453fdbe8ebf549bf097bbfec564583da8 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:14:37 -0800 Subject: [PATCH 06/12] Update README.md --- doc/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 1ac2e6fbcb..5f4ee879ce 100644 --- a/doc/README.md +++ b/doc/README.md @@ -57,9 +57,11 @@ _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 + - [General Settings](help/team-settings/General-Settings.md) + - [Slack Import](help/team-settings/Slack-Import.md) - [Manage Members](help/Manage-Members.md) - - [Slack Import](help/team-settings/Slack-Import.md) - Messaging - [Mattermost Markdown Formatting](usage/Markdown.md) - [Search](help/Search.md) From b4eeb8376eb1e1f6d6976ce62fcae3d480193a53 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:18:11 -0800 Subject: [PATCH 07/12] Update General-Settings.md --- doc/help/team-settings/General-Settings.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/help/team-settings/General-Settings.md b/doc/help/team-settings/General-Settings.md index a35e29df3f..0944e42f75 100644 --- a/doc/help/team-settings/General-Settings.md +++ b/doc/help/team-settings/General-Settings.md @@ -1,17 +1,19 @@ # General Team Settings -## Team Name +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**. + +### 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 +### 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 +### 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 +### 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. From cb041a4f997d651e461e6bd6f32be9ef862650d1 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:25:06 -0800 Subject: [PATCH 08/12] Update and rename doc/help/team-settings/General-Settings.md to doc/help/Team-Settings.md --- doc/help/Team-Settings.md | 54 ++++++++++++++++++++++ doc/help/team-settings/General-Settings.md | 19 -------- 2 files changed, 54 insertions(+), 19 deletions(-) create mode 100644 doc/help/Team-Settings.md delete mode 100644 doc/help/team-settings/General-Settings.md diff --git a/doc/help/Team-Settings.md b/doc/help/Team-Settings.md new file mode 100644 index 0000000000..6c2973dc74 --- /dev/null +++ b/doc/help/Team-Settings.md @@ -0,0 +1,54 @@ +## 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. + +#### 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. + +### 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-settings/General-Settings.md b/doc/help/team-settings/General-Settings.md deleted file mode 100644 index 0944e42f75..0000000000 --- a/doc/help/team-settings/General-Settings.md +++ /dev/null @@ -1,19 +0,0 @@ -# General Team Settings - -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**. - -### 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. From 550e371032d29b4c164bdab18ea959fea0ba8e6f Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:40:11 -0800 Subject: [PATCH 09/12] Update Team-Settings.md --- doc/help/Team-Settings.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/help/Team-Settings.md b/doc/help/Team-Settings.md index 6c2973dc74..47cb0e9ccc 100644 --- a/doc/help/Team-Settings.md +++ b/doc/help/Team-Settings.md @@ -16,6 +16,14 @@ Your **Team Name** is displayed on the sign-in page, and in the top of the left- 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. From 91f23e423e1108baf4930fe15f6b86b9dcbd1229 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:43:02 -0800 Subject: [PATCH 10/12] Update Team-Settings.md --- doc/help/Team-Settings.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/help/Team-Settings.md b/doc/help/Team-Settings.md index 47cb0e9ccc..7e6cf5dd5e 100644 --- a/doc/help/Team-Settings.md +++ b/doc/help/Team-Settings.md @@ -28,6 +28,14 @@ Team Administrators would set this to **No** when they: 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. From 05f2a9cddc701b07094c07e3adda6c9acd1bc621 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:58:11 -0800 Subject: [PATCH 11/12] Update README.md --- doc/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 5f4ee879ce..d062dee658 100644 --- a/doc/README.md +++ b/doc/README.md @@ -58,9 +58,9 @@ _Note: End user help documentation is a new feature being completed for the v1.2 - User Interface - Main Menu - - Team Settings - - [General Settings](help/team-settings/General-Settings.md) - - [Slack Import](help/team-settings/Slack-Import.md) + - [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) From e24524a636792cafd69724ae0a0c6f7c180a824b Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 12 Nov 2015 22:59:12 -0800 Subject: [PATCH 12/12] Delete Slack-Import.md --- doc/help/team-settings/Slack-Import.md | 29 -------------------------- 1 file changed, 29 deletions(-) delete mode 100644 doc/help/team-settings/Slack-Import.md diff --git a/doc/help/team-settings/Slack-Import.md b/doc/help/team-settings/Slack-Import.md deleted file mode 100644 index f834d51774..0000000000 --- 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. -