Documenting Windows functionality for testing

This commit is contained in:
it33
2016-03-12 09:46:39 -08:00
parent 4bee65881b
commit 3c0869256e

View File

@@ -1,4 +1,4 @@
# Electron-Mattermost Setup Guides
# Mattermost Desktop Setup Guides
## Step-by-step Windows setup
@@ -30,11 +30,28 @@ To set up the Mattermost desktop application for Windows 7, 8 and 10:
## Help
The Mattermost desktop application offers:
- Connectivity to one or more Mattermost team sites and multiple Mattermost servers
- Shortcuts from Start Menu and Windows Task Bar
- Icon notifications from Windows Task Bar
- Desktop notifications
See the Mattermost [help documention](http://docs.mattermost.com/help/getting-started/signing-in.html) for how to use the Mattermost team site.
The Mattermost application works in place of a web browser to access your different Mattermost Team Sites, and is controled by a menu bar available from the top of the application.
### Settings Page
### Top Menu:
The Settings Page is available from the **File** menu under **Settings** (Click `Alt` to show the menu if it's not visible). This page manages connections to team sites and other settings.
- **Add a Team Site**:
1. Under **Teams** section, enter **Name** for team name to show in top tab
2. Enter **URL** for the team site location. For example: `https://example.com/teamname` then click **Add**.
- **Delete a Team Site**:
1. Delete a Team Site by clicking the "x" next to the URL of the team site you wish to delete.
- **Hide Menu Bar**
1. Under **Options** enable this option to hide the menu bar by default. Press "Alt" to show the Menu Bar.
### Top Menu
Click the `Alt` key to toggle the menu on and off.
@@ -57,6 +74,19 @@ Below lists menu options (shortcut keys are listed in brackets):
- **Toggle Full Screen** (F11) - Toggle application from window to full screen and back
- **Toggle Developer Tools** (Ctrl+Shift+I) - Turn on and off sidebar showing developer tools
### Notifications
Mattermost lets users configure [desktop notifications](http://docs.mattermost.com/help/getting-started/configuring-notifications.html#desktop-notifications) to alert users to new events in a team site.
For the Mattermost Windows application, these appear as ballon notifications from the task bar on Windows 7 and Windows 8.1, and as a "toast" pop-up on Windows 10.
### Start Menu and Task Bar shortcuts
If pinned to the Windows Start Menu in Step 3 of the setup procedure, a shortcut to the Mattermost desktop application should be available from the Start Menu by pressing the Windows Key.
If pinned to the Windows Task Bar in Step 3 of the setup procedure, a shortcut to the Mattermost desktop application should be available from the Windows Task Bar.
## Step-by-step OS X setup
For OS X 10.11 El Capitan. An older version of OS X has similar way.