Documenter les différents paramètres

[raphodn]

Quoi ?

Pour fonctionner, le projet doit contenir un fichier app/config/parameters.yml, qui liste beaucoup de paramètres. L'idée est d'en documenter un maximum (leurs effets, obligatoire ou pas).

Note : il existe le fichier app/config/parameters.yml.dist qui sert de template / modèle.

Où ?

le wiki de Github (à défaut de mieux)

[raphodn]

Début de doc dans cette page (merci @ctmareil !)
https://github.com/elefan-grenoble/gestion-compte/wiki/Le-fichier-Parameters.yml

[ctmareil]

J'ai fait une première version de la documentation.
Il faut la compléter car il y a des paramètres qui me sont inconnus

[ctmareil]

Voilà la liste des paramètres à mieux documenter

1. Noms et adresses des différents fonctions émettrices de messages

• les adresses emails doivent-elles être différentes?
• les adresses emails doivent-elles exister?

2. Comment utiliser les différentes catégories (formation ?, admin ?...)
3. Clé de sécurité : liste des “certaines fonctions”?
4. A quoi sert local currency name ?
5. Contrôle adresse IP ?
6. Clé du Wiki : parle-t-on du wiki mis en place par elefan ?
7. Créneaux

• cycle_type null pour créneaux volants?
• fly_and_fixed_allow_fixed_shift_free ???

8. Membres

• Allow_extra_shif : existe-i-il une limite de créneaux supplémentaires ?
• max_time in advance : on ne peut réserver un créneau supplémentaires que 3 jours avant
• forbid_shift_overlap_time ???
• max_time_at_end_of_shift ???
• use_fly_and_fixed : lien avec cycle_type ?

9. Compte Epargne

• time_log_saving_shift_free_min_time_in_advance_days ???

10. Divers

• code_generation_enabled => pour la boîte à clé ?
• display_freeze_account ?

[github-actions]

Cette issue semble avoir été oubliée. Sans nouvelle activité, elle sera fermée dans 7 jours.