Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Start writing documentation for gym management

Roland Geiderd0038bf2992d
diff --git a/docs/gym.rst b/docs/gym.rst
index 65cd5ec21..feccb5546 100644
--- a/docs/gym.rst
+++ b/docs/gym.rst
@@ -7,14 +7,47 @@ wger has basic support for gym management. There are 3 groups used for the
different administrative roles:
* **general manager:** Can manage (add, edit, delete) the different gyms for the
- installation but is not allowed to access or add members.
-* **gym manager:** Can manage users for a single gym.
+ installation as well as add gym managers, trainers and member, but is not
+ allowed 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
single gym.
-If the installation is used for a single gym only, you can set the default gym.
-This will update all existing users as well as newly registered ones so they
-belong to that gym
+Except for general managers, administrative users belong to a single gym (the
+one they were created in) and can access only those members. This setting cannot
+be changed later. The user's gym appears in the in the top right menu (with the
+user's name).
+
+.. note:: If the installation is used for a single gym only, you can set the
+ default gym in the global configuration options in the gym list. This will
+ update all existing users as well as newly registered ones so they belong
+ to that gym.
+
+Contracts
+---------
+
+It is also possible to manage the member's contracts with the application. A
+contract is composed of a base form and optional *type* and *options*. The type
+is a single attribute, such as "Student contract" or "Special offer 2016". The
+options are basically the same but more than one can be selected at once and
+can be used for items that can e.g. be booked in addition to the default
+contract such as "Sauna" or "Protein drink flatrate".
+
+The types and the options are added gym-wide in the member overview by the
+managers. Once these are saved, they can be used when adding or editing a
+contract to a specific user.
+
+
+Mass emails
+-----------
+
+
+Member management
+-----------------
+
+
+
Configuration