forked from ScoDoc/DocScoDoc
Petit rafraichissement: structure menus, FAQ, ...
This commit is contained in:
parent
62c921b183
commit
f9727c1057
22
docs/BUT.md
22
docs/BUT.md
@ -171,6 +171,18 @@ TODO *à compléter suivant l'arrêté.*
|
|||||||
|
|
||||||
TODO à rédiger à partir de l'arrêté.
|
TODO à rédiger à partir de l'arrêté.
|
||||||
|
|
||||||
|
### Modules "bonus" (sport, culture, LV2)
|
||||||
|
|
||||||
|
Les modules hors formation comme le sport ou les langues vivantes supplémentaires
|
||||||
|
sont traditionnellement intégrés sous forme de "points de bonus" appliqués sur
|
||||||
|
la moyenne générale. Le BUT, on l'a vu, n'utilise plus la moyenne générale: le
|
||||||
|
bonus pourra donc être appliqué au niveau des moyennes UE: soit sur toutes
|
||||||
|
(bonus fixe ajouté à chaque UE), soit sur un sous-ensemble des UE du semestre.
|
||||||
|
|
||||||
|
Les règles précises du calcul de ce bonus sont malheureusement variables d'un
|
||||||
|
établissement à l'autre: ScoDoc 7 proposait plus d'une douzaine de variantes. La
|
||||||
|
situation sera identique avec le BUT et ScoDoc 9, et la mise en place d'une
|
||||||
|
fonction spécifique dans ScoDoc demandera un paramétrage particulier.
|
||||||
|
|
||||||
# Éditer ou importer une formation
|
# Éditer ou importer une formation
|
||||||
|
|
||||||
@ -253,6 +265,16 @@ exploiter pour un non spécialiste du BUT (poursuites d'études, employeurs).
|
|||||||
|
|
||||||
<img src="/fig/but-bul-lille.png" width="50%">
|
<img src="/fig/but-bul-lille.png" width="50%">
|
||||||
|
|
||||||
|
## Modèle "Bordelais"
|
||||||
|
Cette proposition a été reçue sous différentes formes de plusieurs collègues.
|
||||||
|
L'idée est de présenter le bulletin en deux parties: d'abord les résultats de
|
||||||
|
chaque ressource et SAE, puis les résultats de chaque UE.
|
||||||
|
|
||||||
|
Un exemple préliminaire:
|
||||||
|
|
||||||
|
<img src="/fig/but-bul-bdx.png" width="50%">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Tenue des Jury BUT
|
# Tenue des Jury BUT
|
||||||
|
|
||||||
|
@ -1,17 +1,30 @@
|
|||||||
# Contribuer à ScoDoc
|
# Contribuer à ScoDoc
|
||||||
|
|
||||||
ScoDoc est un logiciel libre, et repose sur des volontaires comme vous. Chacun peut aider, en améliorant la documentation (page, vidéos), en s'abonnant à la liste Notes (voir [listes de diffusion](ListesDeDiffusion.md)) pour y aider les collègues, ou en développant ou testant le logiciel.
|
ScoDoc est un logiciel libre, et repose sur des volontaires comme vous. Chacun
|
||||||
|
peut aider, en améliorant la documentation (page, vidéos), en s'abonnant à la
|
||||||
|
liste Notes (voir [listes de diffusion](ListesDeDiffusion.md)) pour y aider les
|
||||||
|
collègues, ou en développant ou testant le logiciel.
|
||||||
|
|
||||||
Le canal de communication entre développeurs est la liste de diffusion mail [scodoc-devel](ListesDeDiffusion.md). Là, vous pourrez demander un compte sur le [git du projet](https://scodoc.org/git), consulter/ajouter des tickets, proposer votre code (*pull requests*).
|
Les canaux de communication entre développeurs sont d'une part la liste de
|
||||||
|
diffusion mail [scodoc-devel](ListesDeDiffusion.md), d'autre part un serveur
|
||||||
|
Discord (accès sur invitation, demander par mail). Vous pourrez demander un
|
||||||
|
compte sur le [git du projet](https://scodoc.org/git), consulter/ajouter des
|
||||||
|
tickets, proposer votre code (*pull requests*).
|
||||||
|
|
||||||
## Contribuer à la documentation
|
## Contribuer à la documentation
|
||||||
|
|
||||||
La documentation est constituée de deux parties:
|
La documentation est constituée de deux parties:
|
||||||
|
|
||||||
- les vidéos postées sur [la chaîne YouTube](https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1). Proposez de nouvelles vidéos, c'est très facile à faire !
|
- les vidéos postées sur [la chaîne
|
||||||
|
YouTube](https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1).
|
||||||
|
Proposez de nouvelles vidéos, c'est très facile à faire !
|
||||||
|
|
||||||
- Les pages Web comme celle que vous lisez actuellement. La documentation est générée via `MkDocs, un système très simple basé sur le format [Markdown](https://www.markdownguide.org/basic-syntax/). Toutes les sources sont sur le [dépôt git DocScoDoc](https://scodoc.org/git/viennet/DocScoDoc).
|
- Les pages Web comme celle que vous lisez actuellement. La documentation est
|
||||||
|
générée via `MkDocs, un système très simple basé sur le format
|
||||||
|
[Markdown](https://www.markdownguide.org/basic-syntax/). Toutes les sources
|
||||||
|
sont sur le [dépôt git DocScoDoc](https://scodoc.org/git/viennet/DocScoDoc).
|
||||||
|
|
||||||
## Contribuer au logiciel
|
## Contribuer au logiciel
|
||||||
|
|
||||||
Le [dépot principal](https://scodoc.org/git/viennet/ScoDoc) comporte plusieurs branches. Voir le [guide pour les développeurs](GuideDeveloppeurs.md).
|
Le [dépot principal](https://scodoc.org/git/viennet/ScoDoc) comporte plusieurs
|
||||||
|
branches. Voir le [guide pour les développeurs](GuideDeveloppeurs.md).
|
155
docs/FAQ.md
155
docs/FAQ.md
@ -1,69 +1,132 @@
|
|||||||
|
|
||||||
## FAQ
|
## FAQ / Questions fréquemment posées
|
||||||
En cours d'élaboration et en vrac...
|
|
||||||
|
|
||||||
### Le projet ScoDoc
|
## Le projet ScoDoc
|
||||||
#### Qui sont les développeurs ? Le projet est-il pérenne ?
|
### Qui sont les développeurs ? Le projet est-il pérenne ?
|
||||||
|
|
||||||
ScoDoc a été conçu et développé par Emmanuel Viennet, puis complété par plusieurs contributeurs, enseignants ou BIASTSS dans les IUT et universités. Son développement est toujours actif, voir le dépot git <https://scodoc.org/git>.
|
ScoDoc a été conçu et développé par Emmanuel Viennet, puis complété par
|
||||||
|
plusieurs contributeurs, enseignants ou BIATSS dans les IUT et universités. Son
|
||||||
|
développement est toujours actif, voir le dépôt git <https://scodoc.org/git>.
|
||||||
|
|
||||||
En 2020, une association a été crée pour soutenir et pérénniser le projet: par exemple pour acquérir services et équipements pour le développement informatique, recruter stagiaires, ou apprentis, ou mener une veille scientifique et technologique sur le sujet: voir [AssociationScoDoc](AssociationScoDoc.md). L'avenir du logiciel dépend donc de vous: adhérez, ou incitez votre institution (département IUT, Institut, Ecole) à le faire.
|
En 2020, une association a été créée pour soutenir et pérenniser le projet: par
|
||||||
|
exemple pour acquérir services et équipements pour le développement
|
||||||
|
informatique, recruter stagiaires, apprentis, ou mener une veille scientifique
|
||||||
|
et technologique sur le sujet: voir [AssociationScoDoc](AssociationScoDoc.md).
|
||||||
|
L'avenir du logiciel dépend donc de vous: adhérez, ou incitez votre institution
|
||||||
|
(département IUT, Institut, École) à le faire.
|
||||||
|
|
||||||
### Utilisation de ScoDoc
|
## Utilisation de ScoDoc
|
||||||
#### Comment prendre en compte les notes de sport ou autres bonus ?
|
### Comment prendre en compte les notes de sport ou autres bonus ?
|
||||||
Voir [CalculNotes](CalculNotes.md)
|
Voir [CalculNotes](CalculNotes.md)
|
||||||
|
|
||||||
|
|
||||||
#### Qui peut voir les notes, et quand ?
|
### Qui peut voir les notes, et quand ?
|
||||||
Tous les collègues (enseignants et administratifs) pouvant accéder au département peuvent voir les notes, en passant par la page du module concerné.
|
Tous les collègues (enseignants et administratifs) pouvant accéder au
|
||||||
|
département peuvent voir les notes, en passant par la page du module concerné.
|
||||||
|
|
||||||
Les notes n'apparaissent dans les bulletins et tableaux récapitulatifs que lorsqu'elles
|
Les notes n'apparaissent dans les bulletins et tableaux récapitulatifs que
|
||||||
sont prises en compte dans les moyennes: soit parce que toutes les notes des étudiants inscrits à cette évaluation sont saisies, soit parce qu'il s'agit d'une évaluation avec "prise en compte immédiate".
|
lorsqu'elles sont prises en compte dans les moyennes: soit parce que toutes les
|
||||||
|
notes des étudiants inscrits à cette évaluation sont saisies, soit parce qu'il
|
||||||
|
s'agit d'une évaluation avec "prise en compte immédiate".
|
||||||
|
|
||||||
Les **étudiants n'ont pas accès à ScoDoc**, et ne peuvent donc pas voir leurs notes, sauf si une interface spécifique est configurée ("portail", avec affichage sur leur ENT en général, cet affichage pouvant être désactivé depuis ScoDoc pour un semestre particulier). A défaut, il faut leur envoyer leurs bulletins par mail.
|
Les **étudiants n'ont pas accès à ScoDoc**, et ne peuvent donc pas voir leurs
|
||||||
|
notes, sauf si une interface spécifique est configurée ("portail", avec
|
||||||
|
affichage sur leur ENT en général, cet affichage pouvant être désactivé depuis
|
||||||
|
ScoDoc pour un semestre particulier). A défaut, il faut leur envoyer leurs
|
||||||
|
bulletins par mail.
|
||||||
|
|
||||||
|
|
||||||
#### Comment supprimer une évaluation ?
|
### Comment supprimer une évaluation ?
|
||||||
1. Supprimer toutes les notes saisies dans cette évaluation, s'il y en a:
|
1. Supprimer toutes les notes saisies dans cette évaluation, s'il y en a: passer
|
||||||
passer par la page "Saisie des notes" et suivre le lien "Effacer toutes les notes de cette évaluation".
|
par la page "Saisie des notes" et suivre le lien "Effacer toutes les notes de
|
||||||
|
cette évaluation".
|
||||||
|
|
||||||
2. Lorsqu'il n'y a plus de notes, une croix rouge apparait sur le tableau de bord du module: cliquer dessus pour supprimer l'évaluation.
|
2. Lorsqu'il n'y a plus de notes, une croix rouge apparait sur le tableau de
|
||||||
|
bord du module: cliquer dessus pour supprimer l'évaluation.
|
||||||
|
|
||||||
|
|
||||||
#### En IUT, comment gérer les licences professionnelles ?
|
### En IUT, comment gérer les licences professionnelles ?
|
||||||
* On peut créer un département regroupant les licences, ou bien rattacher chaque licence à un département existant. Cette dernière solution est préférable si des étudiants de DUT poursuivent en licence (ainsi, on a automatiquement accès à leur parcours complet).
|
* On peut créer un département regroupant les licences, ou bien rattacher
|
||||||
|
chaque licence à un département existant. Cette dernière solution est
|
||||||
|
préférable si des étudiants de DUT poursuivent en licence (ainsi, on a
|
||||||
|
automatiquement accès à leur parcours complet).
|
||||||
|
|
||||||
* La plupart des licences pro durent un an, mais sont gérées comme un seul semestre (pas de jury à mi-parcours). Indiquer "*pas de semestre*" dans l'option "*Semestre dans la formation*" (page "*modification du semestre*").
|
* La plupart des licences pro durent un an, mais sont gérées comme un seul
|
||||||
|
semestre (pas de jury à mi-parcours). Indiquer "*pas de semestre*" dans
|
||||||
|
l'option "*Semestre dans la formation*" (page "*modification du semestre*").
|
||||||
|
|
||||||
#### Comment gérer les étudiants les démissionnaires ?
|
### Comment gérer les étudiants les démissionnaires ?
|
||||||
* Sur la fiche d'un étudiant, on peut choisir plusieurs options:
|
* Sur la fiche d'un étudiant, on peut choisir plusieurs options:
|
||||||
|
|
||||||
* *Supprimer cet étudiant* : il sera totalement supprimé de la base, sans remède. Cette option n'est en principe jamais utile, sauf pour corriger une fausse manœuvre au moment des inscriptions.
|
* *Supprimer cet étudiant* : il sera totalement supprimé de la base, sans
|
||||||
|
remède. Cette option n'est en principe jamais utile, sauf pour corriger
|
||||||
|
une fausse manœuvre au moment des inscriptions.
|
||||||
|
|
||||||
Ou bien au niveau de son inscription dans un semestre, via le menu *Scolarité*:
|
Ou bien au niveau de son inscription dans un semestre, via le menu *Scolarité*:
|
||||||
|
|
||||||
* *Démission* : l'étudiant restera dans le semestre, mais sera indiqué comme démissionnaire. C'est ce qu'il faut faire quand un étudiant signale son abandon en cours d'année, passé le délai légal ou il peut se désengager (typiquement, après le 15 octobre).
|
* *Démission* : l'étudiant restera dans le semestre, mais sera indiqué comme
|
||||||
|
démissionnaire. C'est ce qu'il faut faire quand un étudiant signale son
|
||||||
|
abandon en cours d'année, passé le délai légal ou il peut se désengager
|
||||||
|
(typiquement, après le 15 octobre).
|
||||||
|
|
||||||
* *Désinscrire (en cas d'erreur)* : l'étudiant reste dans ScoDoc, ses données (et ses notes) sont conservées, mais il n'est plus inscrit au semestre et n'apparait plus dans les listes. C'est ce qu'il faut choisir en début d'année, soit en cas d'erreur de manipulation, soit si l'étudiant abandonne en tout début d'année (il ne sera alors pas compté dans les inscrits).
|
* *Désinscrire (en cas d'erreur)* : l'étudiant reste dans ScoDoc, ses
|
||||||
|
données (et ses notes) sont conservées, mais il n'est plus inscrit au
|
||||||
|
semestre et n'apparait plus dans les listes. C'est ce qu'il faut choisir
|
||||||
|
en début d'année, soit en cas d'erreur de manipulation, soit si l'étudiant
|
||||||
|
abandonne en tout début d'année (il ne sera alors pas compté dans les
|
||||||
|
inscrits).
|
||||||
|
|
||||||
### Configuration
|
### Mes données sont erronées, que faire ?
|
||||||
#### Comment changer les logos sur les documents PDF (PV...)
|
En cas de problème (bug, erreur de manipulation, suspicion de piratage),
|
||||||
|
différents journaux peuvent être consultés.
|
||||||
|
|
||||||
|
Les utilisateurs autorisés peuvent facilement voir:
|
||||||
|
* les opérations effectuées sur un étudiant (inscriptions, saisies d'absences,
|
||||||
|
...), accessibles via le menu "Etudiant" / "Voir le journal..." en haut de sa
|
||||||
|
fiche individuelle.
|
||||||
|
|
||||||
|
* les différentes saisies de notes, via le formulaire de saisie de notes (toutes
|
||||||
|
les valeurs précédemment saisies sont conservées, ainsi que la date et
|
||||||
|
l'identité de l'utilisateur ayant effectué la saisie).
|
||||||
|
|
||||||
|
Les administrateurs (informaticiens) peuvent aussi consulter les journaux (logs)
|
||||||
|
du serveur, voir plus loin.s
|
||||||
|
|
||||||
|
### Comment signaler un problème ?
|
||||||
|
Nous vous remercions de nous signaler tous les problèmes que vous rencontrez:
|
||||||
|
erreurs, comportement bizarre ou malcommode. Nous ne promettons pas de les
|
||||||
|
régler rapidement, ni même plus tard: le logiciel est fourni sans aucune
|
||||||
|
garantie. Mais nous faisons de notre mieux:
|
||||||
|
|
||||||
|
- si vous êtes utilisateurs, écrire à
|
||||||
|
[notes@listes.univ-paris13.fr](mailto:notes@listes.univ-paris13.fr).
|
||||||
|
- si vous êtes informaticien et voulez évoquer un problème technique
|
||||||
|
(développement, installation), écrire à
|
||||||
|
[scodoc-devel@listes.univ-paris13.fr](mailto:scodoc-devel@listes.univ-paris13.fr).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
### Comment changer les logos sur les documents PDF (PV...)
|
||||||
|
|
||||||
|
|
||||||
Il faut (pour l'instant) être administrateur sur le serveur ScoDoc, et passer
|
Il faut (pour l'instant) être administrateur sur le serveur ScoDoc, et passer
|
||||||
par l'onglet "configuration" accessible aux admins sur la page d'accueil.
|
par l'onglet "configuration" accessible aux admins sur la page d'accueil.
|
||||||
|
|
||||||
Les logos sont stockés dans le répertoire `/opt/scodoc-data/config/logos/` et
|
Les logos sont stockés dans le répertoire `/opt/scodoc-data/config/logos/` et
|
||||||
doivent être des images JPEG (extension `.jpg`).
|
doivent être des images JPEG (extension `.jpg`). Il faut aussi indiquer les
|
||||||
Il faut aussi indiquer les tailles des images dans le fichier de configuration `config/scodoc_config.py`, variable `CONFIG.LOGO_FOOTER_HEIGHT` etc.
|
tailles des images dans le fichier de configuration `config/scodoc_config.py`,
|
||||||
|
variable `CONFIG.LOGO_FOOTER_HEIGHT` etc.
|
||||||
|
|
||||||
* Sur les PV, `logo_header.jpg` est affiché en haut, et `logo_header.jpg` en bas de la page.
|
* Sur les PV, `logo_header.jpg` est affiché en haut, et `logo_header.jpg` en bas de la page.
|
||||||
* Sur les bulletins de notes, c'est configurable (et on peut utiliser d'autres logos), voir [ParametrageBulletins](ParametrageBulletins.md)
|
* Sur les bulletins de notes, c'est configurable (et on peut utiliser d'autres
|
||||||
|
logos), voir [ParametrageBulletins](ParametrageBulletins.md)
|
||||||
|
|
||||||
|
|
||||||
#### Administration
|
### Administration
|
||||||
|
|
||||||
#### Quel système d'exploitation ?
|
### Quel système d'exploitation ?
|
||||||
ScoDoc est accessible depuis n'importe quel navigateur Web (Firefox, Chrome, ...).
|
ScoDoc est accessible depuis n'importe quel navigateur Web (Firefox, Chrome, ...).
|
||||||
|
|
||||||
Le serveur ScoDoc fonctionne sous linux. Il n'est testé qu'avec Debian (stable).
|
Le serveur ScoDoc fonctionne sous linux. Il n'est testé qu'avec Debian (stable).
|
||||||
@ -73,7 +136,7 @@ ScoDoc. Une distribution sous forme de container Docker est envisagée.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Quand et comment mettre à jour le logiciel ?
|
### Quand et comment mettre à jour le logiciel ?
|
||||||
Des améliorations et corrections sont fréquemment introduites. Les plus
|
Des améliorations et corrections sont fréquemment introduites. Les plus
|
||||||
importantes sont annoncées sur la liste de diffusion
|
importantes sont annoncées sur la liste de diffusion
|
||||||
"[scodoc-annonces](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-annonces)".
|
"[scodoc-annonces](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-annonces)".
|
||||||
@ -82,27 +145,29 @@ Voir aussi la page [MisesAJour](MisesAJour.md).
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Quelles sauvegardes des données ?
|
### Quelles sauvegardes des données ?
|
||||||
Voir [SauvegardesBases](SauvegardesBases.md).
|
Voir [SauvegardesBases](SauvegardesBases.md).
|
||||||
|
|
||||||
|
|
||||||
#### Où sont les journaux (logs) ?
|
### Où sont les journaux (logs) ?
|
||||||
En cas de problème (bug, erreur de manipulation, suspicion de piratage), différents journaux peuvent être consultés.
|
|
||||||
|
|
||||||
* Le journal du serveur Web nginx
|
Les administrateurs du serveur peuvent consulter:
|
||||||
|
* Le journal du serveur Web (nginx)
|
||||||
```
|
```
|
||||||
/var/log/nginx/scodoc*.log
|
/var/log/nginx/scodoc*.log
|
||||||
```
|
```
|
||||||
|
|
||||||
* les opérations effectuées sur un étudiant sont accessibles via le menu "Etudiant" / "Voir le journal..." en haut de la fiche individuelle de l'étudiant.
|
* le fichier `/opt/scodoc-data/log/scodoc.log` reçoit des messages de déboggage
|
||||||
|
de ScoDoc.
|
||||||
* le fichier `/opt/scodoc-data/log/scodoc.log` reçoit des messages de déboggage de ScoDoc. (c'est là que sont écrits les messages envoyés par la fonction `log()` dans le code de ScoDoc).
|
|
||||||
|
|
||||||
|
|
||||||
|
### J'ai installé ScoDoc mais je n'ai pas de certificat SSL !
|
||||||
#### Je n'ai pas de certificat SSL !
|
Il est de plus en plus important d'installer un certificat SSL; les navigateurs
|
||||||
Il est de plus en plus important d'installer un certificat SSL; les navigateurs Web sont de plus en plus méfiants et vos utilisateurs seront très gênés si votre ScoDoc n'a pas de certificat valide.
|
Web sont de plus en plus méfiants et vos utilisateurs seront très gênés si votre
|
||||||
Si votre établissement (par exemple via RENATER) ne vous fournit pas de de certificat, je conseille de passer par <a href="https://letsencrypt.org/fr/">Let's Encrypt</a> dont l'utilisation est très simple et rapide.
|
ScoDoc n'a pas de certificat valide. Si votre établissement (par exemple via
|
||||||
|
RENATER) ne vous fournit pas de de certificat, je conseille de passer par <a
|
||||||
|
href="https://letsencrypt.org/fr/">Let's Encrypt</a> dont l'utilisation est très
|
||||||
|
simple et rapide.
|
||||||
|
|
||||||
Pour vos tests en local, avec Chrome, modifier le paramétrage en réglant:
|
Pour vos tests en local, avec Chrome, modifier le paramétrage en réglant:
|
||||||
`chrome://flags/#allow-insecure-localhost` (et/ou taper "thisisunsafe" sur la
|
`chrome://flags/#allow-insecure-localhost` (et/ou taper "thisisunsafe" sur la
|
||||||
@ -110,9 +175,9 @@ page bloquée).
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Comment supprimer un département ?
|
### Comment supprimer un département ?
|
||||||
Voir les commandes d'administration dans [GuideConfig](GuideConfig.md)
|
Voir les commandes d'administration dans [GuideConfig](GuideConfig.md)
|
||||||
|
|
||||||
|
|
||||||
#### Comment contribuer au projet ?
|
### Comment contribuer au projet ?
|
||||||
[Voir la page](Contribuer.md).
|
[Voir la page](Contribuer.md).
|
||||||
|
@ -1,6 +1,8 @@
|
|||||||
|
|
||||||
# Guide ScoDoc pour le chef de département
|
# Guide ScoDoc pour le ou la responsable de formation
|
||||||
Dans cette partie, nous allons apprendre à:
|
|
||||||
|
Cette partie s'adresse plutôt aux responsables de formation (cheffes ou chefs de
|
||||||
|
département IUT, responsable de filières, ...). Nous allons apprendre à:
|
||||||
|
|
||||||
* définir une formation (saisie du programme pédagogique définissant les modules)
|
* définir une formation (saisie du programme pédagogique définissant les modules)
|
||||||
|
|
||||||
|
@ -92,7 +92,7 @@ Ajoute ou retire une permission.
|
|||||||
## 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 prends du temps.
|
mais prend du temps.
|
||||||
|
|
||||||
Se reporter à [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
|
Se reporter à [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ Quelques conseils, indications et mémos pour les développeurs sur ScoDoc versi
|
|||||||
|
|
||||||
### Style et formatage du code
|
### Style et formatage du code
|
||||||
L'ancienneté de la base de code a rendu le style un peu incohérent, mais cela
|
L'ancienneté de la base de code a rendu le style un peu incohérent, mais cela
|
||||||
s'améliore avec ScoDoc 9 (respect PEP 8).
|
s'est amélioré avec ScoDoc 9 (respect PEP 8).
|
||||||
|
|
||||||
Le code doit être formatté avec [`black`](https://black.readthedocs.io/) avant
|
Le code doit être formatté avec [`black`](https://black.readthedocs.io/) avant
|
||||||
tout commit (configurez votre éditeur pour appeler `black` à l'enregistrement).
|
tout commit (configurez votre éditeur pour appeler `black` à l'enregistrement).
|
||||||
@ -58,13 +58,14 @@ Exemple:
|
|||||||
|
|
||||||
Le dépot est <https://scodoc.org/git/viennet/ScoDoc>
|
Le dépot est <https://scodoc.org/git/viennet/ScoDoc>
|
||||||
|
|
||||||
La branche `master` est celle de ScoDoc 9 (pas encore en production). La branche
|
La branche `master` est celle de ScoDoc 9. La branche `Scodoc7` est l'ancienne
|
||||||
`Scodoc7` est l'ancienne (actuelle jusqu'à septembre 2021) en production.
|
(jusqu'à septembre 2021) version en production.
|
||||||
|
|
||||||
Ci-dessous quelques pense-bête qui peuvent servir.
|
Ci-dessous quelques pense-bête qui peuvent servir.
|
||||||
#### Hot fixes (internes)
|
#### Hot fixes (internes)
|
||||||
|
|
||||||
Pour les développeurs internes (écriture sur le dépot master), un exemple basique:
|
Pour les développeurs internes (écriture sur le dépôt master), un exemple
|
||||||
|
basique:
|
||||||
|
|
||||||
# Créer une branche
|
# Créer une branche
|
||||||
# si besoin (travail en cours), utiliser git stash avant
|
# si besoin (travail en cours), utiliser git stash avant
|
||||||
@ -83,7 +84,8 @@ Pour les développeurs internes (écriture sur le dépot master), un exemple bas
|
|||||||
|
|
||||||
#### Mettre à jour votre branche
|
#### Mettre à jour votre branche
|
||||||
|
|
||||||
Vous travaillez dans votre branche `ma_branche`. Pour lui appliquer les mises à jour de `master` (remote):
|
Vous travaillez dans votre branche `ma_branche`. Pour lui appliquer les mises à
|
||||||
|
jour de `master` (remote):
|
||||||
|
|
||||||
git pull origin master
|
git pull origin master
|
||||||
|
|
||||||
@ -123,7 +125,8 @@ Voir [TestsScoDoc](TestsScoDoc.md)
|
|||||||
|
|
||||||
## Cache Redis
|
## Cache Redis
|
||||||
|
|
||||||
Certains objets couteux à calculer sont cachés. Depuyis ScoDoc 9, on utilise Redis, via `flask-caching`.
|
Certains objets couteux à calculer sont cachés. Depuis ScoDoc 9, on utilise
|
||||||
|
Redis, via `flask-caching`.
|
||||||
|
|
||||||
Au besoin, mémo:
|
Au besoin, mémo:
|
||||||
|
|
||||||
@ -133,7 +136,8 @@ Au besoin, mémo:
|
|||||||
|
|
||||||
- `redis-cli TTL key` affiche le TTL d'un clé, -1 si infini.
|
- `redis-cli TTL key` affiche le TTL d'un clé, -1 si infini.
|
||||||
|
|
||||||
- `redis-cli -r -1 -i 3 KEYS '*_NT_*'` surveille certaines clés (ici _NT_), affche toutes les 3 secondes.
|
- `redis-cli -r -1 -i 3 KEYS '*_NT_*'` surveille certaines clés (ici _NT_),
|
||||||
|
affiche toutes les 3 secondes.
|
||||||
|
|
||||||
- `flask clear-cache` efface le cache Redis.
|
- `flask clear-cache` efface le cache Redis.
|
||||||
|
|
||||||
@ -141,9 +145,10 @@ Au besoin, mémo:
|
|||||||
## Roadmap
|
## Roadmap
|
||||||
Sujets **prioritaires** en 2021:
|
Sujets **prioritaires** en 2021:
|
||||||
|
|
||||||
- modernisation du code: Flask, Python 3: achevé août 2021
|
- Modernisation du code: Flask, Python 3: achevé août 2021.
|
||||||
|
|
||||||
- prise en compte du Bachelor (BUT): SAÉ, suivi compétences, validations des blocs, UE, semestres selon la cadrage et l'arêté Licence Pro 2020.
|
- Prise en compte du Bachelor (BUT): SAÉ, suivi compétences, validations des
|
||||||
|
blocs, UE, semestres selon la cadrage et l'arrêté Licence Pro 2020.
|
||||||
|
|
||||||
- Redéfinition API et interface mobile simplifiée.
|
- Redéfinition API et interface mobile simplifiée.
|
||||||
|
|
||||||
|
@ -30,8 +30,8 @@ disparaitront en juillet 2022.
|
|||||||
|
|
||||||
Certaines ont plusieurs "routes" (URl), car ScoDoc 7 tolérait divers accès.
|
Certaines ont plusieurs "routes" (URl), car ScoDoc 7 tolérait divers accès.
|
||||||
|
|
||||||
- `Absences/XMLgetBilletsEtud`
|
- `Absences/XMLgetBilletsEtud` (deviendra `api/absences/billets/etud/<etudid>`)
|
||||||
- `Absences/listeBillets`
|
- `Absences/AddBilletAbsence` (deviendra `api/absences/billet/add`)
|
||||||
- `Absences/XMLgetAbsEtud`
|
- `Absences/XMLgetAbsEtud`
|
||||||
- `Notes/formsemestre_list`
|
- `Notes/formsemestre_list`
|
||||||
- `Notes/formsemestre_bulletinetud`
|
- `Notes/formsemestre_bulletinetud`
|
||||||
@ -42,6 +42,9 @@ les routes ci-dessus s'entendent à partir de l'URL de base de votre ScoDoc, c'e
|
|||||||
à dire `https://votre.site.fr/ScoDoc/<dept>/Scolarite/`, et répondent en GET et
|
à dire `https://votre.site.fr/ScoDoc/<dept>/Scolarite/`, et répondent en GET et
|
||||||
en POST.
|
en POST.
|
||||||
|
|
||||||
|
Note:
|
||||||
|
- `Absences/listeBillets` est un formulaire et ne fait pas partie de l'API.
|
||||||
|
|
||||||
|
|
||||||
# XXX à rédiger XXX Fonctions d'accès aux données
|
# XXX à rédiger XXX Fonctions d'accès aux données
|
||||||
## Départements
|
## Départements
|
||||||
|
BIN
docs/fig/but-bul-bdx.png
Normal file
BIN
docs/fig/but-bul-bdx.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 228 KiB |
12
mkdocs.yml
12
mkdocs.yml
@ -10,6 +10,7 @@ nav:
|
|||||||
- '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
|
||||||
- 'FAQ': FAQ.md
|
- 'FAQ': FAQ.md
|
||||||
|
|
||||||
- Installation:
|
- Installation:
|
||||||
- 'Guide administration': GuideAdminSys.md
|
- 'Guide administration': GuideAdminSys.md
|
||||||
- 'Installation': GuideInstallDebian11.md
|
- 'Installation': GuideInstallDebian11.md
|
||||||
@ -19,9 +20,14 @@ nav:
|
|||||||
- 'Export Apogée': ScoDocApogee.md
|
- 'Export Apogée': ScoDocApogee.md
|
||||||
- 'API': ScoDocAPI.md
|
- 'API': ScoDocAPI.md
|
||||||
|
|
||||||
- Utilisateurs: UtilisateursScoDoc.md
|
- Association:
|
||||||
- Association: AssociationScoDoc.md
|
- 'Association 1901': AssociationScoDoc.md
|
||||||
- Sources: https://scodoc.org/git
|
- 'Utilisateurs': UtilisateursScoDoc.md
|
||||||
|
|
||||||
|
- Développement:
|
||||||
|
- 'Git': https://scodoc.org/git
|
||||||
|
- 'Guide Développeurs': GuideDeveloppeurs.md
|
||||||
|
|
||||||
- FAQ: FAQ.md
|
- FAQ: FAQ.md
|
||||||
|
|
||||||
# theme: readthedocs
|
# theme: readthedocs
|
||||||
|
Loading…
Reference in New Issue
Block a user