[chronojump-server] Adding server user guide and explanations



commit fafea86f6c6519682270b57044be244278dcb6c9
Author: Max Ros i Morejon <mros33 gmail com>
Date:   Fri Jun 28 13:32:20 2019 +0200

    Adding server user guide and explanations

 user_guide_server.txt | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
---
diff --git a/user_guide_server.txt b/user_guide_server.txt
new file mode 100644
index 0000000..41e7971
--- /dev/null
+++ b/user_guide_server.txt
@@ -0,0 +1,71 @@
+Consideracions inicials:
+
+    S'ha d'entrar amb una sessió per a poder fer qualsevol cosa.
+    Un usuari només pot pertanyer a una organització.
+    Un usuari no podrà veure un equip si l'usuari no n'és responsable o entrenador, per molt que pertanyi a 
la mateixa organització.
+    Un usuari podrà veure tots els gimnassos que disposa la organització a la que pertany sense necessitat 
de ser-ne el responsable i podrà crear i editar els exercicis de les estacions del gimnàs.
+    
+    Accions que només es poden fer mitjançant la consola d'administrador:
+        - Crear, editar o eliminar un usuari.
+        - Crear, editar o eliminar un gimnàs.
+        - Crear, editar o eliminar una estació.
+        - Eliminar un exercici d'una determinada estació.
+        
+    
+    Tipus d'usuari:
+    Usuari és un membre del club (no jugador), els jugadors no són usuaris sinó objectes del server.
+        Staff: Pot accedir a la consola d'administrador. Usuaris de Chronojump
+        Superuser: Disposa de tots els permisos d'entrada. Sense aquest no es pot editar res.
+        Team responsible: Pot afegir o expulsar jugadors de l'equip del que és responsable
+        Gym responsible: No té cap benefici actualment
+        Organization responsible: No té cap benefici actualment
+        Coach: Pot accedir a la pàgina de l'equip, veure els jugadors que en formen part i assignar tasques 
a aquests
+        
+        
+Barra de navegació superior:
+
+Si l'usuari es troba al menu inicial només veurà el nom d'usuari i la opció de tancar la sessió.
+
+Quan l'usuari entri a alguna altre pàgina podrà veure els següents elements:
+    - Logo de Chronojump. Et retorna a la pàgina inicial
+    - Home. Fa el mateix que el logo, et retorna a la pàgina inicial
+    - Results. Obre un desplegable per navegar directament a les pàgines de Encoder Results i Sprint Results
+    - Groups. Obre un desplegable per navegar directament a les pàgines de cada group del que l'usuari en 
sigui responsable o entrenador.
+    - Gyms. Obre un desplegable per navegar directament a les pàgines de cada gimnàs de l'organització.
+    - Hello, user. Amb el nom de l'usuari, no té cap funcionalitat.
+    - Close session. Botó per a tancar la sessió d'usuari.
+
+    
+Menu inicial:
+
+    - Imatge i nom de la organització a la que pertany l'usuari.
+
+    - Player results:
+        - Encoder results: Aparaixeran tots els resultats realitzats amb l'encoder gravitatori. Es poden 
filtrar per data, grup, jugador, estació i exercici. També es poden exportar, eliminar o ordenar per atributs.
+        
+        - Sprint results: Aparaixeran tots els resultats realitzats amb la galga d'sprint. Es poden filtrar 
per data, grup i jugador. També es poden exportar, eliminar o ordenar per atributs.
+    
+    - My groups: Apareixen tots els grups en els que l'usuari n'és responsable o entrenador.
+        - Grup: Dins de la pàgina de qualsevol dels grups veurem el següent:
+            - Responsable i gimnàs: A dalt a la dreta explica qui és el responsable de l'equip i a quin 
gimnàs pertany.
+            - Add i Remove players: 
+                Només podran veure aquests botons el responsable del grup seleccionat.
+                El botó blau serveix per a afegir jugadors existents (creats previament a la pàgina de 
jugadors) a la plantilla de l'equip. 
+                El botó rosa serveix per a expulsar jugadors de la plantilla de l'equip. Aquests jugadors no 
seràn eliminats, tan sols deixaran de formar part de l'equip (poden tornar en qualsevol moment). Per a 
eliminar als jugadors s'han de seleccionar mitjançant el checkbox de la dreta.
+            - Taula de jugadors:
+                Cada fila de la taula pertany a un jugador. Aquesta taula es pot ordenar per valors dels 
atributs. El signe + de la dreta serveix per a assignar una nova tasca a aquell jugador. El botó + de 
l'esquerra serveix per a desplegar la taula de tasques del jugador on es podràn editar i eliminar. La taula 
es pot amagar amb el botó de -. 
+    
+    - My gyms: Apareixen tots els gimnassos de l'organització a la que pertany l'usuari.
+        - Gym: Dins de la pàgina de qualsevol dels gyms veurem el següent:
+            - Responsable: A dalt a la dreta explica qui és el responsable del gimnàs.
+            - Add exercise: Permet afegir un nou exercici a l'estació que es determini en el formulari.
+            - Taula d'estacions:
+                Les estacions estan agrupades en els 3 tipus d'estacions. Per cada estació es podrà obrir un 
desplegable que contindrà tots els seus exercicis per tal de poder-los editar.
+    
+    - Organization options:
+        - Players: Pàgina per a crear jugadors. Només en poden crear els responsables de cada equip i 
responsable de l'organització. Per crear un jugador s'ha de tenir obert el server de rfid_bridge ja que es 
necessita associar un rfid al jugador. També es pot associar una imatge o esborrar-la amb el botó. Es poden 
esborrar amb els checkbox i editar.
+        
+        - Groups: Pàgina per a crear grups. Només els pot crear el responsable de la organització. També es 
poden esborrar i editar aquí. La taula està relacionada amb altres taules per a poder mostrar els noms del 
responsable i el gimnàs i no els seus ids.
+        
+        - Gyms: Pàgina per a mostrar gimnassos. De moment ningú en pot crear de nous ni modificar-los. Només 
llistar, ordenar i filtrar.
+    


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]