Self hosted FLOSS fitness/workout, nutrition and weight tracker
Update gym.rst documentation
jaspreetsd902079de87590c5
diff --git a/docs/gym.rst b/docs/gym.rstindex a18104017..7b07747da 100644--- a/docs/gym.rst+++ b/docs/gym.rst@@ -1,14 +1,13 @@.. _gym:Gym administration-==================+-------------------wger has support for gym and member management, allowing e.g. trainers to follow-the progress of their athletes and for the gym managers to keep track of the-member's contracts.+wger provides support for managing both gyms and members. For example,+trainers/coaches can follow their students progress, and gym managers are+able to keep track of their members contracts.-It is possible to manage a single or different ones with one instance of wger.-If the installation is used for a single gym only, you can set the+If the installation is being used for a single gym, you can set thedefault gym in the global configuration options in the gym list. This willupdate all existing users as well as newly registered ones so they belongto that gym.@@ -16,14 +15,16 @@ to that gym.There are 3 groups used for the different administrative roles:-* **general manager:** Can manage (add, edit, delete) the different gyms for the+* **General Manager:** Can manage (add, edit, delete) the different gyms for theinstallation as well as add gym managers, trainers, and members but is notallowed to see the members' workout data.-* **gym manager:** Can manage users for a single gym (editing, deactivating,- adding contracts, etc.).-* **trainer:** Can manage the workouts and other data for the members of a+* **Gym Manager:** Can manage the users for a single gym (editing, deactivating,+ and adding contracts, etc.).+* **Trainer:** Can manage the workouts and other data for the members of asingle gym.++These roles are not mutually exclusive, if your workflow demands it, you cancombine all three roles into one account.@@ -31,23 +32,35 @@ Except for general managers, administrative users belong to a single gym (theone they were created in) and can access only those members. This setting cannotbe changed later. The user's gym appears in the top-right menu.--Member management+Member Management------------------You can add members to a gym by clicking the *Add member* button at the top of-the member overview. After filling in the form, a password will be generated-for the user. You should save this and give it to the user, as it is not possible-to retrieve it later. Alternatively, you can just instruct the new members to-use the reset password links when logging in for the first time.+To add members to a gym:++1. Click the ``Add Member`` button at the top of the member overview.+2. Fill in the form to generate a password for the user.+3. Save this password and give it to the user and it cannot be retrieved later.++ OR++1. Click the ``Add Member`` button at the top of the member overview.+2. Instruct new members to use the reset password links when logging in for the first time.+++To export all gym members:++1. Navigate to the ``Actions`` button on the gym detail page.+2. Here, you are provided with a CSV file that can be imported into a spreadsheet program for further processing.-An export of all gym members is available as well from the "actions" button on-the gym detail table. This provides a CSV file that can be imported into a-spreadsheet program for further processing.Trainers can click on a user and access an overview of the user's workouts,body weights, nutrition plans, etc. When clicking on the "log in as this user",the trainer can assume the identity of the user to create new workouts forexample.+Additionally, Trainers can add notes and upload documents related to individual members. A+note is a free text, while a document can be any file. This information can+be used to save information on specific injuries or other important notes+related to the member. Note that these entries are not accessible by the+members themselves, but only by the trainers.Individual members can be deactivated by clicking on the "actions" button onthe top of the member's detail table. Deactivated users can't log in, but are@@ -56,15 +69,6 @@ If you wish to completely delete a user from the system, use the "delete"option but keep in mind that this action cannot be undone.-Notes and documents---------------------Trainers can add notes and upload documents related to individual members. A-note is a free text, while a document can be any file. This information can-be used to save information on specific injuries or other important notes-related to the member. Note that these entries are not accessible by the-members themselves, but only by the trainers.--Contracts---------@@ -80,18 +84,18 @@ managers. Once these are saved, they can be used when adding or editing acontract to a specific user.-Mass emails+E-Mails------------It is possible to send an email to all members of a gym. At the moment it is-not possible to filter this list or send it only to members that fulfill a-specific criterion.+You can send a batch e-mail to all members of a gym. Currently, there is no support+for filtering members based on specific criterion.+++How to send e-mails:-To send this, go to the gym's overview and click "Add" on the Email actions-button. After filling in the subject and the body you need to accept the-preview, in order to make sure that the text you wrote is indeed the one-you intend to send. After submitting the form, the emails will be sent in-batches (how exactly depends on how you configured the different cron jobs-needed to run the application).+1. Navigate to the gym's overview and click "Add" on the Email actions button.+2. Fill in the subject and the body.+3. Review, and accept the e-mail's preview.+4. After submitting, emails will be delivered in batch format based on your cron jobs configuration.Configuration@@ -99,20 +103,19 @@ ConfigurationInactive members~~~~~~~~~~~~~~~~-The idea behind the inactive members is that trainers want to know which users-have not visited the gym for longer than X weeks and e.g. contact them.-'Inactive' means here that they don't have any logs in the time period.+Inactive members are members that have not logged in for X weeks. For example, a trainer can check to+see which users have not visited the gym in X weeks.This can be configured in the following ways:-**number of weeks**+**Number of Weeks**The value in weeks after which users are considered inactive (default is 8).This applies to the whole gym and can be deactivated by entering a 0.-**trainer configuration**- Each trainer can opt-out of receiving such emails+**Trainer Configuration**+ Each trainer can opt-out of receiving such emails.-**user configuration**+**User Configuration**Individual users can be opt-out of being included in the reminder emails ifthey don't want to use the log for any other reason.@@ -120,4 +123,4 @@ Gym name in the header~~~~~~~~~~~~~~~~~~~~~~A checkbox to control whether the gym's name will appear in the header insteadof the application's name for all logged-in users of this gym. This applies to-members, trainers, and managers.+members, trainers, and managers