Merge branch 'development'

build/help-master.md

@@ -168,6 +168,10 @@
 
 ***
 
+{{> docs/projects/project-collaborators.md}}
+
+***
+
 {{> docs/projects/import-custom-data.md}}
 
 ***

docs/.vuepress/config.js

@@ -3,6 +3,7 @@ module.exports = {
     description: 'Documentation on how to use the PhotosynQ platform, including the web, mobile and desktop applications as well as the instruments.',
     head: [
         ['link', { rel: 'icon', href: '/icons/favicon-32x32.png' }],
+        ['link', { rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css' }],
         ['link', { rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.css' }],
         ['link', { rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/mermaid/7.0.0/mermaid.css' }],
         ['script', {src: 'https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.0.0/mermaid.min.js' }]
@@ -149,6 +150,7 @@ module.exports = {
                     'projects/adding-a-project-description',
                     'projects/editing-a-project',
                     'projects/managing-project-settings',
+                    'projects/project-collaborators',
                     'projects/import-custom-data',
                     'projects/barcodes',
                     'projects/large-scale-projects'
@@ -257,6 +259,10 @@ module.exports = {
         ['@vuepress/pwa', {
             serviceWorker: true,
             updatePopup: true
+        }],
+        ['sitemap', {
+            hostname: 'https://help.photosynq.org',
+            outFile: 'sitemap.xml'
         }]
         // ,
         // ['@vuepress/medium-zoom', {

docs/README.md

@@ -27,9 +27,9 @@ features:
   link: projects/what-are-projects.html
 
 - title: View & Analyze Data
-  details: We are providing libraries for Python and R to access PhotosynQ Project Data to perform an advanced data analysis.
+  details: Data from Projects can be analyzed online, as well as using libraries for Python and R for advanced data analysis.
   linkText: Data Analysis
-  link: https://photosynq.org/software#analysis
+  link: view-and-analyze-data/view-your-project-data.html
 
 - title: Firmware
   details: You get notified when there is an update available for your Instrument if you use the PhotosynQ mobile or desktop application.

docs/account/change-your-email-address.md

@@ -2,11 +2,11 @@
 
 Need to change your current email address? No problem. Just follow the steps to update your profile to maintain you access to you account.
 
-## Update your email in your user profile
+## User profile
 
-1. Go to <https://photosynq.org> and sign in to your account.
-2. Open your user page by clicking on your name in the top **Menu**.
-3. On the left hand side click on **Account Settings**.
+1. Go to <https://photosynq.org> and [sign in] to your account.
+2. Open your user page by clicking on your **avatar** in the top **Menu**.
+3. On the left hand side click on **Manage Profile** in the menu underneath your avatar.
 4. Update your email address.
 5. Click on **Update** to save your changes!
 6. Open your email inbox and click on the confirmation link inside the email that was just send to you.
@@ -24,3 +24,5 @@ Before you contact us, make sure you checked the following steps:
 ::: warning
 **Still Issues?** Please contact us (<support@photosynq.org>), so we can try to help you out.
 :::
+
+[sign in]: ./sign-in-to-photosynq.md

docs/account/create-an-account.md

@@ -1,10 +1,20 @@
 # Create an Account
 
-1. You can create an account from the website (<https://photosynq.org>). Just select the "sign up" button from the top menu of the website.
-2. Create a username and password for your account. This login will be used across the PhotosynQ platform.
-3. Check your email for a confirmation.
+Anyone with a valid email address can create an account and join the PhotosynQ community. You can view and analyze data, search projects and contribute in the forums. For creating protocols & macros as well as taking measurements, an Instrument is required.
+
+## Signing up
+
+1. Navigate to the PhotosynQ website (<https://photosynq.org>) and select [sign up] from the top menu.
+2. Enter your name, institution/organization (optional) and biography (optional).
+3. Add a photo that will be used as an avatar (optional).
+4. Add your **email address** and **password** you want to use for the account. They serve as the login across the PhotosynQ platform.
+5. Check your email for a confirmation.
    - Click on the confirmation link and your account has been activated and can be used.
-4. Now go back to the website or app and sign in.
+6. Now go back to the website or app and [sign in].
+
+::: tip
+**Tip:** Adding a biography and a photo will help other users who may be interested in collaborating with you!
+:::
 
 ### Troubleshooting
 
@@ -14,3 +24,6 @@
 ::: warning
 **Still Issues?** Please contact us (<support@photosynq.org>), so we can help you getting your account confirmed.
 :::
+
+[sign up]: https://photosynq.org/users/sign_up
+[sign in]: https://photosynq.org/users/sign_in

docs/account/deactivate-an-account.md

@@ -1,6 +1,6 @@
 # Deactivate an Account
 
-If you would like to leave PhotosynQ and deactivate your account, please contact us (<support@photosynq.org>).
+If you would like to leave PhotosynQ and deactivate your account, please contact us (<support@photosynq.org>). Remember to provide name and email when contacting support.
 
 ::: warning
 **Note:** When you are deactivating your account, your public contributions will be anonymized and remain accessible to others.

docs/account/edit-your-profile.md

@@ -1,22 +1,21 @@
 # Edit Your Profile
 
-Your profile on PhotosynQ will help others to learn more about you and start collaborations. Here you can find how to make changes to your profile.
+Your profile on PhotosynQ helps others to learn more about you and to start collaborations. Here you can find how to make changes to your profile.
 
-## Fill out the user information
+## User information
 
-1. Open your user page by clicking on your name in the top **Menu**.
-2. On the left hand side click on **Account Settings**.
-3. Make changes to your profile.
+1. Open your user page by clicking on your **avatar** in the top **Menu**.
+2. On the left hand side click on **Manage Profile**.
+3. Make changes to your **name**, **institution** and/or **biography**.
 4. Click on **Update** to save your changes!
 
-## Add a profile photo
+## Profile photo (Avatar)
 
-1. Open your user page by clicking on your name in the top **Menu**.
-2. On the left hand side click on **Account Settings**.
-3. Scroll to the bottom of your profile form and click on **Select Photo**.
-4. Select the photo you would like to use and click **Open**.
-5. Click on **Update** to save your new photo!
+1. Open your user page by clicking on your **avatar** in the top **Menu**.
+2. On the left hand side click on **Manage Profile**.
+3. Click on **Select Photo** underneath the current one and upload your new picture.
+4. Scroll down to the bottom and click on **Update** to save your new photo!
 
 ::: tip
-**Tip:** Adding a biography and a photo will help other users who may be interested in collaborating with you!
+**Tip:** Keeping you biography and institute/organization up to date will help others to find you and start collaborations.
 :::

docs/account/manage-your-password.md

@@ -2,6 +2,15 @@
 
 If you forgot your password or you want to change it, you can do this easily at any time.
 
+## Change your account password
+
+You know your password and you want to change it, go to <https://photosynq.org>:
+
+1. Open your user page by clicking on your name in the top **Menu**.
+2. On the left hand side click on **Account Settings**.
+3. Type in your new Password and type it again into the Password confirmation.
+4. Click on **Update** to save your new password!
+
 ## Reset your password
 
 If you forgot your password go to <https://photosynq.org>:
@@ -12,15 +21,6 @@ If you forgot your password go to <https://photosynq.org>:
 4. Open your email inbox and click on the link.
 5. Set your new password.
 
-## Change your account password
-
-You know your password and you want to change it, go to <https://photosynq.org>:
-
-1. Open your user page by clicking on your name in the top **Menu**.
-2. On the left hand side click on **Account Settings**.
-3. Type in your new Password and type it again into the Password confirmation.
-4. Click on **Update** to save your new password!
-
 ### Troubleshooting
 
 - Sometimes the confirmation emails end up in your spam folder. Make sure to check it first.

docs/account/project-invitations.md

@@ -1,51 +1,25 @@
 # Project Invitations
 
-You can invite collaborators to your Projects and others can invite you to collaborate on their Projects.
-
-## Invite a Collaborator to Your Project
-
-You can invite collaborators to join your Project either when you are creating a Project, or invite them to an already created Project.
-
-To invite collaborators while creating a Project:
-
-1. In the **Settings** tab, select **Collaborators only** from the "Who can contribute data to your Project" drop down menu
-2. Enter the email address of the collaborator you are inviting in the **Invite collaborator** box
-3. After typing in the email address, click the **Add** button. You can invite as many collaborators has you want, and you can choose if you want them to be a collaborator (meaning they can contribute data) or an administrator (meaning they can edit you Project)
-4. Once you have finished inviting collaborators, click **Save and Finish** from the bottom of the page
-
-![Invite Collaborator](./images/invite-collaborator.jpg)
-
-Inviting collaborators to an existing Project:
-
-1. Go to the Project homepage on <https://photosynq.org>
-2. Click on the **Options** menu. The options menu will only be visible if you are the Project administrator
-3. Select **Settings**
-4. Follow steps 1-4 above to invite collaborators
-
-![Project options](./images/project-options.jpg)
-
-::: tip
-**Tip:** If you have selected the **Anyone** option from the "Who can contribute data to your Project" menu, then you do not need to send an invitation to collaborators. Instead they can **join** the Project from the Project homepage by clicking the **Join Team** button.
-:::
+If somebody wants you to join a project that is not open to everyone, you will receive an invitation as a collaborator or admin.
 
 ## Accept Invitations
 
 1. Open your user page by clicking on your name in the top **Menu**.
 2. On the left hand side click on **Invitations**. The little badge indicates if there are new invites.
 3. Check your list of available invitations and click on **Join** if you want to collaborate.
 
-::: warning
-**Note:** You will receive an email as well. Click on the link inside the email to join the Project.
-:::
-
 ::: tip
 **Tip:** Below the Project name it is indicated if you are invited as a **Collaborator** or **Administrator**.
 :::
 
 ![Invitations](../projects/images/invitations.png)
 
+::: tip
+**Tip:** You will receive an email as well. Click on the link inside the email to join the Project.
+:::
+
 ## Decline Invitations
 
-1. Open your user page by clicking on your name in the top **Menu**.
+1. Open your user page by clicking on your avatar in the top **Menu**.
 2. On the left hand side click on **Invitations**. The little badge indicates if there are new invites.
 3. Check your list of available invitations and click on **Decline Invitation** if you don't want to collaborate on this Project.

docs/account/sign-in-to-photosynq.md

@@ -2,25 +2,31 @@
 
 Sign in to access your work on PhotosynQ. You can only have one account active at a time.
 
-## Web
+::: tip
+You need an account and the email address and password connected with the account.
+:::
+
+## Browser
 
-1. Click on **Login** in the top menu bar.
-2. Enter your email address and password.
+1. Visit [photosynq.org/sign_in] or click on **Login** in the top menu bar if you are already on the page
+2. Enter your **email address** and **password**.
 3. If you wish to stay signed in, check **Remember me**
-4. Click on **Sign in**.
+4. Click **Sign in**.
 
 ## Android
 
-1. Tab the PhotosynQ icon to start the app.
-2. Enter your email address and password.
-3. Tab on **Login**.
+1. Open the PhotosynQ App.
+2. Enter your **email address** and **password**.
+3. Tap on **Login**.
 
 ## Desktop
 
-1. Start the app by selecting the PhotosynQ app from your application folder.
-2. Enter your email address and password.
+1. Start the PhotosynQ App.
+2. Enter your **email address** and **password**.
 3. Click on **Sign in**.
 
 ::: warning
 **Note:** Make sure you have an internet connection when you sign in so your work can be synchronized.
 :::
+
+[photosynq.org/sign_in]: https://photosynq.org/users/sign_up

docs/account/sign-out-of-photosynq.md

@@ -1,17 +1,19 @@
-# Sign Out to PhotosynQ
+# Sign Out of PhotosynQ
 
-It is quick and easy to sign out of PhotosynQ and you can sign back in at any time.
+It is quick and easy to sign out of PhotosynQ and you can [sign back in] at any time.
 
-## Web
+## Browser
 
 1. Click on **Sign out** in the top menu bar.
 
 ## Android
 
-1. Tab the <i class="fa fa-bars"></i> overflow menu in the top left corner.
-2. Tab on your photo to bring up your profile.
-3. Tab on **Logout**.
+1. Tap the <i class="fa fa-bars"></i> overflow menu in the top left corner.
+2. Tap on your avatar to bring up your profile.
+3. Tap on **Logout**.
 
 ## Desktop
 
-1. Select **File** from the application menu and click on **Sign out**.
+1. Select **File** from the application menu and click on **Sign out**.
+
+[sign back in]: ./sign-in-to-photosynq.md

docs/desktop-application/connect-an-instrument.md

@@ -1,6 +1,6 @@
 # Connect an Instrument
 
-You can use Bluetooth or USB to connect your Instrument with your computer. Depending on the Instrument and computer, some connection options may not be available.
+You can use **Bluetooth** or **USB** to connect your Instrument with your computer. Depending on the Instrument and computer, some connection options may not be available.
 
 ::: warning
 **Note:** Before connecting your MultispeQ to the Desktop App you need to turn on the MultispeQ by pressing and holding the power button for at least 5 seconds.
@@ -14,7 +14,7 @@ You can use Bluetooth or USB to connect your Instrument with your computer. Depe
 2. Choose the **Connection** tab from the settings menu.
 3. Pick the port the Instrument is connected to from the dropdown menu:
     - Windows: **COM{number}**
-    - Mac OS: **usbmodem{number}**
+    - MacOS: **usbmodem{number}**
     - Linux: **ACM{number}**
 4. Connect the instrument by clicking on **Connect**.
 
@@ -25,7 +25,7 @@ You can use Bluetooth or USB to connect your Instrument with your computer. Depe
 3. Choose the **Connection** tab from the dialog.
 4. Pick the port the Instrument is connected to from the dropdown menu:
     - Windows: **COM{number}**
-    - Mac OS: **Instrument-name_{number}**
+    - MacOS: **Instrument-name_{number}**
     - Linux: **Not available**
 5. Connect the device by clicking on **Connect**.
 
@@ -36,4 +36,4 @@ If you are having trouble connecting to your Instrument, please go through this
 - Make sure your Instrument is fully charged (at least 6h, or over night).
 - Make sure you have turned on the Instrument by pressing and holding the power button for at least 5 seconds. **The Instrument will automatically shut off after 3 hours of inactivity by default**
 - If you were using the Instrument with another mobile device, you will need to press and hold the power button for 5 seconds to disconnect it from the current device and make it available to the new one.
-- If you are using Windows 8 or lower, make sure you have the [serial driver](https://www.pjrc.com/teensy/td_download.html) installed.
+- If you are using Windows 8 or lower, make sure you have the [serial driver](https://www.pjrc.com/teensy/td_download.html) installed.

docs/desktop-application/installation.md

@@ -5,7 +5,7 @@ Taking measurements in the in the lab, developing new measurement protocols and
 ## Download the PhotosynQ Application
 
 1. Go to [https://photosynq.org/software](https://photosynq.org/software/#desktop) and scroll to the **Desktop App**.
-2. Download the app for your operating system.
+2. Download the application for your operating system.
 
 ## Installation
 
@@ -26,7 +26,7 @@ When using Windows older than Windows 10, a serial driver needs to be installed.
 
 ### MacOS
 
-![Installation of the Application from the Disk-Image (macOS)](./images/install-application-mac.png)
+![Installation of the Application from the Disk-Image (MacOS)](./images/install-application-mac.png)
 
 1. Navigate to the file you just downloaded.
 2. Double click the file to open the disk-image.
@@ -40,6 +40,14 @@ When using Windows older than Windows 10, a serial driver needs to be installed.
 **Note:** Right now there is no version available. If you are interested in helping us testing, please send a request to <support@photosynq.org>.
 :::
 
+## Minimum Requirements
+
+| Operating System |    Requirements     |
+| :--------------- | :------------------ |
+| MacOS            | OS X 10.10 or above |
+| Windows          | Windows 7 or above  |
+| Linux            | not available       |
+
 ## Starting the app for the first time
 
 When you are starting the app for the first time you will be asked for your login credentials. If you don't already have an account, please follow the **sign up** link in the login dialog to create an account. After that use the login credentials to sign in to the app.
@@ -67,4 +75,4 @@ Sometimes the app does not work as expected. Please try this first:
 - Make sure you have an internet connection.
 - Restart the device before installing.
 
-[application settings]: ./settings.md
+[application settings]: ./settings.md