jmplace/DocScoDoc
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Projects Releases Wiki Activity

Correction Guide Config.

Browse Source
This commit is contained in:
Emmanuel Viennet 2022-04-24 23:19:00 +02:00
parent edfd1266be
commit d020dbbe73
4 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/BUT.md
View File

@ -1,5 +1,15 @@
# Le BUT # Le Bachelor Universitaire de Technologie (BUT)
Formation en trois ans dispensées par les IUT français, introduite en 2021, et
basée sur une forme d'approche par compétences nécessitant un système
d'évaluation spécifique.
Cette page décrit les principaux éléments du BUT utiles à comprendre pour le
gérer avec ScoDoc. Pour les curieux, la page
[modélisation des parcours BUT](ModelisationParcoursBUT.md)
donne quelques détails sur la façon dont ScoDoc organise les objets du BUT.
## UE, modules, évaluations ## UE, modules, évaluations

3
docs/GuideAdminSys.md
View File

@ -19,8 +19,9 @@ Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de mac
## Configuration et préférences ## Configuration et préférences
* [Administration en ligne de commande](GuideConfig.md)
* [ConfigPermissions](ConfigPermissions.md) : description des permissions et rôles utilisés par le système. * [ConfigPermissions](ConfigPermissions.md) : description des permissions et rôles utilisés par le système.
* [ Paramétrage](PreferencesScoDoc.md): réglage des préférences * [Paramétrage](PreferencesScoDoc.md): réglage des préférences
## Autres problèmes ## Autres problèmes

32
docs/GuideConfig.md
View File

@ -1,5 +1,5 @@
# Prise en main et paramétrage de ScoDoc 9 ## Prise en main et paramétrage de ScoDoc 9
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Cette <img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Cette
page concerne la version ScoDoc 9, distribuée à partir de septembre 2021. page concerne la version ScoDoc 9, distribuée à partir de septembre 2021.
@ -8,7 +8,7 @@ Ce document suppose que le logiciel a été installé suivant la procédure déc
[GuideInstallDebian11](GuideInstallDebian11.md). [GuideInstallDebian11](GuideInstallDebian11.md).
# Administration en ligne de commande ## Administration en ligne de commande
Les opérations d'administration se résument à la création de départements, et l'installation Les opérations d'administration se résument à la création de départements, et l'installation
des logos, et la création d'utilisateurs "super admin", c'est à dire admin pour tous les des logos, et la création d'utilisateurs "super admin", c'est à dire admin pour tous les
@ -31,21 +31,21 @@ Après quoi, vous pouvez utiliser les commandes décrites ci-dessous.
*Attention: le lancement de chaque commande est assez long (quelques secondes) *Attention: le lancement de chaque commande est assez long (quelques secondes)
car toute l'application scodoc est initialisée à chaque fois.* car toute l'application scodoc est initialisée à chaque fois.*
## Création d'un département ### Création d'un département
flask create-dept DEPT flask create-dept DEPT
où `DEPT` est l'acronyme du département, par exemple "RT". Ce département où `DEPT` est l'acronyme du département, par exemple "RT". Ce département
apparait immédiatement sur la page d'accueil. apparait immédiatement sur la page d'accueil.
## Suppression d'un département ### Suppression d'un département
Opération très rarement nécessaire, proposée pour corriger une erreur Opération très rarement nécessaire, proposée pour corriger une erreur
immédiatement après la création. immédiatement après la création.
flask delete-dept DEPT flask delete-dept DEPT
## Création d'un utilisateur ### Création d'un utilisateur
Cette opération s'effectue en général depuis le logiciel, via un formulaire Cette opération s'effectue en général depuis le logiciel, via un formulaire
ou un import Excel. Pour créer un utilisateur depuis le terminal, lancer: ou un import Excel. Pour créer un utilisateur depuis le terminal, lancer:
@ -54,7 +54,7 @@ ou un import Excel. Pour créer un utilisateur depuis le terminal, lancer:
où `LOGIN` sera le pseudo de l'utilisateur (utilisé pour se connecter), où `LOGIN` sera le pseudo de l'utilisateur (utilisé pour se connecter),
et `ROLE` le rôle (`Ens`, `Secr`, `Admin`) dans le département `DEPT`. et `ROLE` le rôle (`Ens`, `Secr`, `Admin`) dans le département `DEPT`.
## Création d'un super-administrateur ### Création d'un super-administrateur
Il s'agit d'un utilisateur ayant tous les droits, comme s'il était Il s'agit d'un utilisateur ayant tous les droits, comme s'il était
`Admin` dans tous les départements. `Admin` dans tous les départements.
@ -63,7 +63,7 @@ Il s'agit d'un utilisateur ayant tous les droits, comme s'il était
où `admin2` est ici le pseudo du nouvel admin. où `admin2` est ici le pseudo du nouvel admin.
## Changement du mot de passe d'un utilisateur ### Changement du mot de passe d'un utilisateur
Cette opération peut s'effectuer via la page de gestion web des Cette opération peut s'effectuer via la page de gestion web des
utilisateurs, mais il est parfois commode de le faire depuis la utilisateurs, mais il est parfois commode de le faire depuis la
console: console:
@ -73,7 +73,7 @@ console:
où `LOGIN` est le pseudo de l'utilisateur. Le mot de passe est demandé où `LOGIN` est le pseudo de l'utilisateur. Le mot de passe est demandé
sur la ligne de commande. sur la ligne de commande.
## Création d'un nouveau rôle ### Création d'un nouveau rôle
flask create-role role_name [permissions...] flask create-role role_name [permissions...]
@ -81,13 +81,13 @@ Exemple: création d'une rôle "Observateur" ayant juste la permission de "voir"
flask create-role Observateur ScoView flask create-role Observateur ScoView
## Édition d'un rôle (ajout/retrait permissions) ### Édition d'un rôle (ajout/retrait permissions)
flask edit-role [-a permission] [-r permission] role_name flask edit-role [-a permission] [-r permission] role_name
Ajoute ou retire une permission. Ajoute ou retire une permission.
## Ajout/retrait d'un rôle à un utilisateur ### Ajout/retrait d'un rôle à un utilisateur
flask user-role username [-d departement] [-a RoleAAjouter] [-r RoleARetirer] flask user-role username [-d departement] [-a RoleAAjouter] [-r RoleARetirer]
@ -102,7 +102,7 @@ Si le département n'est pas spécifié, le rôle est donné dans *tous* les
départements (utile pour certains compte administrateurs ou utilisés en lecture départements (utile pour certains compte administrateurs ou utilisés en lecture
par des clients de l'API). par des clients de l'API).
## Migration des données de ScoDoc 7 ### Migration des données de ScoDoc 7
Les données dans ScoDoc 9 ayant un format et une organisation très différents Les données dans ScoDoc 9 ayant un format et une organisation très différents
de ScoDoc 7, une étape de conversion (migration) est nécessaire. Elle est automatique de ScoDoc 7, une étape de conversion (migration) est nécessaire. Elle est automatique
mais prend du temps. mais prend du temps.
@ -112,14 +112,14 @@ Se reporter à [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
Ces commandes sont utilisées par le script de migration de ScoDoc 7 à ScoDoc 9. Ces commandes sont utilisées par le script de migration de ScoDoc 7 à ScoDoc 9.
*Ne pas utiliser sauf si vous savez vraiment ce que vous faites.* *Ne pas utiliser sauf si vous savez vraiment ce que vous faites.*
### Comptes utilisateurs #### Comptes utilisateurs
Toujours migrer les comptes utilisateurs avant d'importer les Toujours migrer les comptes utilisateurs avant d'importer les
départements. départements.
flask import-scodoc7-users flask import-scodoc7-users
### Départements #### Départements
Pour migrer un seul département: Pour migrer un seul département:
flask import-scodoc7-dept DEPT DBNAME flask import-scodoc7-dept DEPT DBNAME
@ -128,7 +128,7 @@ Exemple:
flask import-scodoc7-dept InfoComm DBINFOCOMM flask import-scodoc7-dept InfoComm DBINFOCOMM
## Liste des commandes Flask/ScoDoc ### Liste des commandes Flask/ScoDoc
``` ```
Usage: app [OPTIONS] COMMAND [ARGS]... Usage: app [OPTIONS] COMMAND [ARGS]...
@ -315,7 +315,7 @@ Options:
(*la liste ci-dessus est générée à l'aide de la commande* `flask dumphelp`). (*la liste ci-dessus est générée à l'aide de la commande* `flask dumphelp`).
## Changement des logos apparaissant sur les documents ### Changement des logos apparaissant sur les documents
*Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*. *Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*.
@ -338,7 +338,7 @@ Après quoi, redémarrez ScoDoc après avoir vidé les caches:
sudo systemctl restart scodoc9 sudo systemctl restart scodoc9
# Utilisation via le Web ## Utilisation via le Web
* Connectez-vous au site: `https://votre.site.fr/` * Connectez-vous au site: `https://votre.site.fr/`

1
mkdocs.yml
View File

@ -22,6 +22,7 @@ nav:
- "Guide utilisateur": GuideUtilisateur.md - "Guide utilisateur": GuideUtilisateur.md
- "Tutos vidéos": https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1 - "Tutos vidéos": https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1
- "Responsables de formations": GuideAdminFormation.md - "Responsables de formations": GuideAdminFormation.md
- "Le BUT": BUT.md
- "FAQ": FAQ.md - "FAQ": FAQ.md
- Installation: - Installation: