From 3c0869256efcddabd5ce335411b93e9c2cab9484 Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 09:46:39 -0800 Subject: [PATCH 1/8] Documenting Windows functionality for testing --- docs/setup.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index d7299f5b..52f7bdb8 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -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. From b7a5b8755bed9f14c6f2347a5ce058a2479d3dab Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 09:48:21 -0800 Subject: [PATCH 2/8] Changing "menubar" to "Menu Bar" More common phrasing --- src/browser/settings.jsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/browser/settings.jsx b/src/browser/settings.jsx index c25e53a8..05e1fc6a 100644 --- a/src/browser/settings.jsx +++ b/src/browser/settings.jsx @@ -72,7 +72,7 @@ var SettingsPage = React.createClass({ var options = []; if (process.platform === 'win32' || process.platform === 'linux') { - options.push(); + options.push(); } var options_row = (options.length > 0) ? ( From 5fb9e51fc0598bc77bf9adc1ec2df60e8a8f15c5 Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 10:05:06 -0800 Subject: [PATCH 3/8] Renaming "Top Menu" to "Menu Bar" For consistency --- docs/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.md b/docs/setup.md index 52f7bdb8..7265402d 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -51,7 +51,7 @@ The Settings Page is available from the **File** menu under **Settings** (Click - **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 +### Menu Bar Click the `Alt` key to toggle the menu on and off. From 7561970daf53651af344212e06c29904512d734d Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 10:10:22 -0800 Subject: [PATCH 4/8] Create TESTING.md Initial draft of testing instructions across operating systems, begins with Windows testing guide --- TESTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 TESTING.md diff --git a/TESTING.md b/TESTING.md new file mode 100644 index 00000000..3ce8505c --- /dev/null +++ b/TESTING.md @@ -0,0 +1,47 @@ +# Mattermost Desktop App Testing + +## Release Testing Guide + +To contribute to the process of testing the Mattermost Desktop App: + +1. If you haven't already, create an account on https://pre-release.mattermost.com/core + - Set your username to be the same as your GitHub username +2. Follow the testing guide for your platform + - [Windows Testing Guide](#windows-testing-guide) +3. Go to the [Public Test Channel](https://pre-release.mattermost.com/core/channels/public-test-channel) and try the following: + 1. Post the message with information on what you're testing, for example: `Testing Mattermost Desktop App 1.07 on Windows 7 SP1 64-bit` + 2. Reply to the post by clicking on "**...**" then "**Reply**" with `This is a comment including files` and upload five (5) files including at least one image, one sound file and one video clip from your Android device. + 3. Search for the word "Desktop" and click "Jump" on the search result of your own post in Step 3.1. Click into the preview of the files you uploaded and try to download each one. +4. For any bugs found, please [file an issue report for each](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md#issue). + 1. Please include: + - STEPS TO REPRODUCE + - MATTERMOST DESKTOP APP VERSION + - OPERATING SYSTEM VERSION + - SCREENSHOT IF APPLICABLE + 2. See [example of Mattermost Desktop issue](https://github.com/mattermost/desktop/issues/63) +5. When your testing is complete, open a GitHub Issue announcing your device has been verified + 1. Open an issue [using template for announcing a platform has been tested](https://github.com/mattermost/platform/issues/2275). + +# THANK YOU! +We highly appreciate your help improving the quality of the Mattermost Desktop App for the entire community. + +Your testing contribution, including GitHub username, will be listed under the [Verified Operating Systems](TESTING.md#verified-operation-systems) section of this document. + +# Verified Operating Systems + +The following chart summarizes the operating systems which the Mattermost Desktop App releases have been tested: + +| Version | OS | Issues | Tester | Date | +|:--- |:--- |:--- |:--- |:--- | +| 1.07 | Windows 7 SP1 64-bit | [#63](https://github.com/mattermost/desktop/issues/63) | [@it33](https://github.com/it33) | 2016-03-12 | + +# Testing Guides by Operating System + +The following guides offer operating system specific instructions for testing the Mattermost Desktop application. + +## Windows Testing Guide + +1. Install the Mattermost desktop application following the [step-by-step Windows setup guide](docs/setup.md#step-by-step-windows-setup) to connect to the `https://pre-release.mattermost.com/core` team site. +2. Verify [Start Menu and Task Bar shortcuts open the application as documented.](docs/setup.md#start-menu-and-task-bar-shortcuts). +3. Verify [Menu Bar options work as documented](docs/setup.md#menu-bar). +4. Follow the [Release Testing Guide](#release-testing-guide) to file issues and report completion of testing. From 8626a47fcbaaf41a1ec3fb5573667f05efc3f1c2 Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 10:16:14 -0800 Subject: [PATCH 5/8] Adding link example to verification report --- TESTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TESTING.md b/TESTING.md index 3ce8505c..c892394e 100644 --- a/TESTING.md +++ b/TESTING.md @@ -20,7 +20,7 @@ To contribute to the process of testing the Mattermost Desktop App: - SCREENSHOT IF APPLICABLE 2. See [example of Mattermost Desktop issue](https://github.com/mattermost/desktop/issues/63) 5. When your testing is complete, open a GitHub Issue announcing your device has been verified - 1. Open an issue [using template for announcing a platform has been tested](https://github.com/mattermost/platform/issues/2275). + 1. Open an issue [using template for announcing a platform has been tested](https://github.com/mattermost/desktop/issues/70). # THANK YOU! We highly appreciate your help improving the quality of the Mattermost Desktop App for the entire community. From bcad1d536d20d132b8341d34c36edd7328cda89d Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 12 Mar 2016 11:00:01 -0800 Subject: [PATCH 6/8] Correcting heading hierarchy --- TESTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/TESTING.md b/TESTING.md index c892394e..584ca256 100644 --- a/TESTING.md +++ b/TESTING.md @@ -22,12 +22,12 @@ To contribute to the process of testing the Mattermost Desktop App: 5. When your testing is complete, open a GitHub Issue announcing your device has been verified 1. Open an issue [using template for announcing a platform has been tested](https://github.com/mattermost/desktop/issues/70). -# THANK YOU! +## THANK YOU! We highly appreciate your help improving the quality of the Mattermost Desktop App for the entire community. Your testing contribution, including GitHub username, will be listed under the [Verified Operating Systems](TESTING.md#verified-operation-systems) section of this document. -# Verified Operating Systems +## Verified Operating Systems The following chart summarizes the operating systems which the Mattermost Desktop App releases have been tested: @@ -35,11 +35,11 @@ The following chart summarizes the operating systems which the Mattermost Deskto |:--- |:--- |:--- |:--- |:--- | | 1.07 | Windows 7 SP1 64-bit | [#63](https://github.com/mattermost/desktop/issues/63) | [@it33](https://github.com/it33) | 2016-03-12 | -# Testing Guides by Operating System +## Testing Guides by Operating System The following guides offer operating system specific instructions for testing the Mattermost Desktop application. -## Windows Testing Guide +### Windows Testing Guide 1. Install the Mattermost desktop application following the [step-by-step Windows setup guide](docs/setup.md#step-by-step-windows-setup) to connect to the `https://pre-release.mattermost.com/core` team site. 2. Verify [Start Menu and Task Bar shortcuts open the application as documented.](docs/setup.md#start-menu-and-task-bar-shortcuts). From b946ba1b10b4404ed4fec1ba99c98dfd2731e17b Mon Sep 17 00:00:00 2001 From: it33 Date: Sun, 13 Mar 2016 08:43:57 -0700 Subject: [PATCH 7/8] Correct build number format --- TESTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TESTING.md b/TESTING.md index 584ca256..5973231b 100644 --- a/TESTING.md +++ b/TESTING.md @@ -33,7 +33,7 @@ The following chart summarizes the operating systems which the Mattermost Deskto | Version | OS | Issues | Tester | Date | |:--- |:--- |:--- |:--- |:--- | -| 1.07 | Windows 7 SP1 64-bit | [#63](https://github.com/mattermost/desktop/issues/63) | [@it33](https://github.com/it33) | 2016-03-12 | +| 1.0.7 | Windows 7 SP1 64-bit | [#63](https://github.com/mattermost/desktop/issues/63) | [@it33](https://github.com/it33) | 2016-03-12 | ## Testing Guides by Operating System From 65a4625095278314d7bb4d82446d00157ed52db3 Mon Sep 17 00:00:00 2001 From: it33 Date: Sun, 13 Mar 2016 08:44:47 -0700 Subject: [PATCH 8/8] Fixing incorrect reference to Android device --- TESTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TESTING.md b/TESTING.md index 5973231b..1fb3f428 100644 --- a/TESTING.md +++ b/TESTING.md @@ -10,7 +10,7 @@ To contribute to the process of testing the Mattermost Desktop App: - [Windows Testing Guide](#windows-testing-guide) 3. Go to the [Public Test Channel](https://pre-release.mattermost.com/core/channels/public-test-channel) and try the following: 1. Post the message with information on what you're testing, for example: `Testing Mattermost Desktop App 1.07 on Windows 7 SP1 64-bit` - 2. Reply to the post by clicking on "**...**" then "**Reply**" with `This is a comment including files` and upload five (5) files including at least one image, one sound file and one video clip from your Android device. + 2. Reply to the post by clicking on "**...**" then "**Reply**" with `This is a comment including files` and upload five (5) files including at least one image, one sound file and one video clip from your computer. 3. Search for the word "Desktop" and click "Jump" on the search result of your own post in Step 3.1. Click into the preview of the files you uploaded and try to download each one. 4. For any bugs found, please [file an issue report for each](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md#issue). 1. Please include: