From f9caeb90f3de59e2a407b9423e03dfc7bf538e13 Mon Sep 17 00:00:00 2001 From: viennet Date: Mon, 27 May 2024 12:58:01 +0200 Subject: [PATCH] Modif URL gitea: git.scodoc.org --- docs/Contact.md | 2 +- docs/Contribuer.md | 6 +++--- docs/DevGit.md | 24 ++++++++++++------------ docs/DevInternals.md | 2 +- docs/Evaluation.md | 16 +++++++++++----- docs/FAQ.md | 2 +- docs/GuideDeveloppeurs.md | 4 ++-- docs/GuideUtilisateur.md | 9 ++++++--- docs/IntroObjetsScoDoc.md | 4 ++-- docs/ScoDoc9API.md | 14 ++++++-------- mkdocs.yml | 2 +- 11 files changed, 46 insertions(+), 39 deletions(-) diff --git a/docs/Contact.md b/docs/Contact.md index 8053aa6a1..b3591c1b2 100644 --- a/docs/Contact.md +++ b/docs/Contact.md @@ -33,7 +33,7 @@ permet d'indiquer le semestre et l'étudiant à regarder. Vous trouverez les sources du projet, les tickets (*issues*) et autres outils sur -* [gitea](https://scodoc.org/git/) +* [gitea](https://git.scodoc.org) Vous pouvez demander un compte sur cette plate-forme pour ajouter des tickets, proposer votre code (*pull requests*). diff --git a/docs/Contribuer.md b/docs/Contribuer.md index 6023830cc..8d104d2e3 100644 --- a/docs/Contribuer.md +++ b/docs/Contribuer.md @@ -7,7 +7,7 @@ collègues, ou en développant ou testant le logiciel. Les canaux de communication entre développeurs sont [indiqués sur cette page](Contact.md). Vous pouvez demander un compte sur le [git du - projet](https://scodoc.org/git), consulter/ajouter des tickets, proposer votre + projet](https://git.scodoc.org), consulter/ajouter des tickets, proposer votre code (*pull requests*). ## Contribuer à la documentation @@ -21,11 +21,11 @@ La documentation est constituée de deux parties: - 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). + sont sur le [dépôt git DocScoDoc](https://git.scodoc.org/viennet/DocScoDoc). ## Contribuer au logiciel -Le [dépôt principal](https://scodoc.org/git/viennet/ScoDoc) comporte plusieurs +Le [dépôt principal](https://git.scodoc.org/viennet/ScoDoc) comporte plusieurs branches. Voir le [guide pour les développeurs](GuideDeveloppeurs.md). diff --git a/docs/DevGit.md b/docs/DevGit.md index cd1feaed9..93094859c 100644 --- a/docs/DevGit.md +++ b/docs/DevGit.md @@ -1,6 +1,6 @@ # Utilisation de git pour ScoDoc -Le dépôt est +Le dépôt est La branche `master` est celle de ScoDoc 9, d'où sont issues les paquets distribués (*releases*). Les développements ont lieu sur d'autres branches @@ -48,7 +48,7 @@ mises à jour de `master` (remote), faire: Vous travaillez sur un clone du dépôt principal ("origin"), obtenu par exemple via ```bash -git clone https://scodoc.org/git/ScoDoc/ScoDoc.git +git clone https://git.scodoc.org/ScoDoc/ScoDoc.git ``` remplacer par l'URL de votre dépôt sur gitea au besoin. Si vous avez votre @@ -57,12 +57,12 @@ nommé `mon_origin`), l'autre pour le dépôt principal ScoDoc (ici nommé `origin`). ```bash -git remote add origin https://scodoc.org/git/viennet/ScoDoc.git +git remote add origin https://git.scodoc.org/viennet/ScoDoc.git git remote -v mon_origin https://xxx.xxx (fetch) mon_origin https://xxx.xxx (push) -origin https://scodoc.org/git/viennet/ScoDoc.git (fetch) -origin https://scodoc.org/git/viennet/ScoDoc.git (push) +origin https://git.scodoc.org/viennet/ScoDoc.git (fetch) +origin https://git.scodoc.org/viennet/ScoDoc.git (push) ``` Ensuite, tout est prêt, vous créez votre branche: @@ -103,7 +103,7 @@ Lint tous les fichiers modifiés: Affiche les variables non définies dans un fichier: ```bash - pylint --disable=all -e E sco_parcours_dut.py | grep undefined-variable | awk '{print $4;}' | sort | uniq | tr -d \' + pylint --disable=all -e E sco_parcours_dut.py | grep undefined-variable | awk '{print $4;}' | sort | uniq | tr -d \' ``` Prépare un sed pour renommer les variables non définies: @@ -154,14 +154,14 @@ la mise en place, le suivi et la livraison. #### L'installation Il est pratique d'avoir en ligne les deux dépôts git distants que vous pouvez -utiliser : votre dépôt personnel (`https://scodoc.org/git//.git`) et -le dépôt officiel (`https://scodoc.org/git/ScoDoc/ScoDoc.git`). +utiliser : votre dépôt personnel (`https://git.scodoc.org//.git`) et +le dépôt officiel (`https://git.scodoc.org/ScoDoc/ScoDoc.git`). pour ajouter une référence (et lui donner un nom) vers un dépôt distant, entrez la commande: ```bash - git remote add nom_remote https://scodoc.org/git/ScoDoc/.git + git remote add nom_remote https://git.scodoc.org/ScoDoc/.git ``` Par la suite vous aurez donc une référence vers votre dépôt personnel (`perso`) @@ -186,7 +186,7 @@ suivantes par `git stash` (avant) et `git stash apply` (après) : ```bash git reset --hard officiel/master - git checkout -b ma_modif + git checkout -b ma_modif ``` À partir de là, vous pouvez modifier, tester, développer et commit votre travail. @@ -249,7 +249,7 @@ l'équivalent sous *pyCharm*). for fn in $(git diff --name-only officiel/master) do python3 -m black $fn - done + done ``` Faire une première lecture rapide pour vérifier qu'il ne reste pas de fichiers @@ -384,7 +384,7 @@ soit refusé (car le rebase a modifié des commits qui avaient déjà été pous Dans ce cas l'option `--force` du push vous permette de passer outre, mais assurez-vous avant d'être le seul à travailler sur cette branche. -#### Etape 5 : La dernière étape se passe sur le site [scodoc.org/git](https://scodoc.org/git/) +#### Etape 5 : La dernière étape se passe sur le site [git.scodoc.org](https://git.scodoc.org/) - Identifiez-vous diff --git a/docs/DevInternals.md b/docs/DevInternals.md index 41f97a488..36ea9f380 100644 --- a/docs/DevInternals.md +++ b/docs/DevInternals.md @@ -132,7 +132,7 @@ http GET http://localhost:5000/ScoDoc/api/formsemestres/query "Authorization:Bea ### Côté programmation serveur Reprenons le même exemple (voir `app/api/formsemestres.py`` ligne 91, -): +): ```py @bp.route("/formsemestres/query") diff --git a/docs/Evaluation.md b/docs/Evaluation.md index aa36c55ba..8561f10e1 100644 --- a/docs/Evaluation.md +++ b/docs/Evaluation.md @@ -19,7 +19,9 @@ qui peuvent être négatives). compte dans les moyennes même si l'évaluation n'est pas affichée. - **Prise en compte immédiate**: si coché, les notes saisies dans l'évaluation seront prises en compte dans le calcul des moyennes avant même que les notes - de tous les étudiants ne soit saisies. + de tous les étudiants ne soit saisies. Ne pas utiliser pour les évaluations de + rattrapage ou de deuxième session (qui sont prises en compte quand elles + existent). ### Pourquoi éviter d'utiliser "prise en compte immédiate" ? @@ -61,12 +63,13 @@ l'évaluation est dite *en attente*. Elle est prise en compte. ## Modalité d'une évaluation - **Normale**: produit une note utilisée dans le calcul des moyennes du module. -- **Rattrapage**: la note d'une évaluation de "rattrapage" remplacera la moyenne - du module de l'étudiant *si et seulement si elle est meilleures que celles - calculées*. - **Deuxième session**: la note remplace, lorsqu'elle est saisie, la moyenne de l'étudiant à ce module, même si sa note de deuxième session est plus faible que sa moyenne normale. +- **Rattrapage**: la note d'une évaluation de "rattrapage" remplacera la moyenne + du module de l'étudiant *si et seulement si elle est meilleure que celles + calculées*. S'il y a des évaluations de deuxième session, celles de + rattrapage sont ignorées. - **Bonus**: la valeur est ajoutée à la moyenne du module, voir détail ci-dessous. ### Évaluations de "bonus" @@ -75,10 +78,13 @@ Les évaluations bonus sont particulières: - la valeur est ajoutée à la moyenne du module; - le bonus peut être négatif (malus); -- le bonus ne s'applique pas aux notes de rattrapage et deuxième session; +- le bonus s'applique après utilisation des notes de rattrapage ou de deuxième session; - le coefficient est ignoré, mais en BUT le bonus vers une UE est multiplié par le poids correspondant (par défaut égal à 1); - les notes de bonus sont prises en compte même si incomplètes. +Note 1: la conformité des évaluations au programme (coefficients vers les UEs) ne +prend pas en compte les évaluations bonus. + ## Bloquage et date de prise en compte Ceci permet d'empêcher la prise en compte (et éventuellement la publication) de diff --git a/docs/FAQ.md b/docs/FAQ.md index f511e0bd4..8fb1cf408 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,7 +6,7 @@ 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 . +développement est toujours actif, voir la plateforme gitea . 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 diff --git a/docs/GuideDeveloppeurs.md b/docs/GuideDeveloppeurs.md index a2e07d00e..63e3a8f79 100644 --- a/docs/GuideDeveloppeurs.md +++ b/docs/GuideDeveloppeurs.md @@ -4,7 +4,7 @@ Informations pour les développeurs souhaitant étendre ou modifier ScoDoc. Pour le développement de logiciels externes, [utiliser l'API](ScoDoc9API.md). -Accès à la [plate-forme Gitea](https://scodoc.org/git). +Accès à la [plate-forme Gitea](https://git.scodoc.org). ## Informations générales @@ -146,7 +146,7 @@ Note: la mise à jour par `apt` recrée le virtualenv à chaque fois. ## Roadmap - * [voir les tickets](https://scodoc.org/git/viennet/ScoDoc/issues) + * [voir les tickets](https://git.scodoc.org/viennet/ScoDoc/issues) !!! note "Voir aussi" diff --git a/docs/GuideUtilisateur.md b/docs/GuideUtilisateur.md index 8a538824c..94ba599f4 100644 --- a/docs/GuideUtilisateur.md +++ b/docs/GuideUtilisateur.md @@ -1,5 +1,8 @@ # Utilisation de ScoDoc +Les [principaux objets de ScoDoc](IntroObjetsScoDoc.md) sont présentés sur +[cette page](IntroObjetsScoDoc.md). + ScoDoc contrôle les opérations via un mécanisme de permissions facile à mettre en œuvre et permettant de bien répartir les rôles entre les utilisateurs: responsables, enseignants, secrétariats. @@ -13,9 +16,9 @@ département. * [Guide pour le responsable de formation](GuideAdminFormation.md) * [Modification d'un programme pédagogique et versions](Formations.md) * [Exemples et partages de programmes pédagogiques entre établissements](ExemplesProgrammesPedagogiques.md) - + * [Importation des étudiants](ImportationEtuds.md) - + * [Synchronisation des inscrits avec Apogée](SynchroApogee.md) * [Procédure d'inscription des étudiants via Apogée](InscriptionsEtudApogee.md) * [Données sur l'origine des étudiants](DonneesAdmissions.md) @@ -30,7 +33,7 @@ département. * [Édition des bulletins de notes](BulletinsNotes.md) * [paramétrage des bulletins pdf](ParametrageBulletins.md) - + * [Édition des PV de jury](ParametragePV.md) * Comment sont calculées les moyennes : [Calcul des notes](CalculNotes.md) diff --git a/docs/IntroObjetsScoDoc.md b/docs/IntroObjetsScoDoc.md index d999f7da6..7e46d74c9 100644 --- a/docs/IntroObjetsScoDoc.md +++ b/docs/IntroObjetsScoDoc.md @@ -25,7 +25,7 @@ une action de formation continue d'une semaine que d'une formation sur un an. Saisie des dates de début et fin d'un semestre: ![sco-dates-semestre.png](screens/sco-dates-semestre.png) -Les semestre a un ou plusieurs (co)responsables, utilisateurs ayant des droits +Chaque semestre a un ou plusieurs (co)responsables, utilisateurs ayant des droits particuliers, dont ceux de modifier la liste des modules d'enseignement à suivre, de nommer les enseignants, etc. Les responsables de semestres sont souvent appelés *directeurs ou directrices des études*. @@ -103,7 +103,7 @@ Exemple: extrait de la fiche d'un étudiant Les étudiants d'un semestre peuvent être répartis dans des groupes. -Chaque *partition* d'un semestre défini un ensemble de groupes: par exemple, les +Chaque *partition* d'un semestre défini un ensemble de groupes: par exemple, la partition des groupes de TD, ou la partition des projets tuteurés. On peut à tout moment créer une partition, y créer des groupes, y placer ou diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index b910e6880..e79190c03 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1546,16 +1546,14 @@ mais pas JSON compliant à cause des `NaN`. * **Permission: `ScoView`** * **Paramètres:** `formsemestre_id` * **Query string**: `format` -* **Route:** `/formsemestres/resultats` +* **Route:** `/formsemestre//resultats` * **Exemple d'utilisation:** `/api/formsemestre/1/resultats` -* **Résultat:** [formsemestre-resultats.json](samples/sample_formsemestre-resultats.json.md) - -Récapitulatif par étudiant (état, groupe(s), moyennes d'UEs et de modules) +* **Résultat:** Récapitulatif par étudiant (état, groupe(s), moyennes d'UEs et de modules) pour un formsemestre spécifié par son id. Par défaut les valeurs numériques sont formatées en chaînes. Si format=raw, valeurs numériques mais pas JSON compliant à cause des `NaN`. -* **Exemple de résultat:** +* **Exemple de résultat:** [formsemestre-resultats.json](samples/sample_formsemestre-resultats.json.md) #### **`moduleimpl-evaluations`** @@ -1733,16 +1731,16 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Exemple d'utilisation:** `/api/assiduite/1` * **Résultat:** Retourne un objet assiduité ou une erreur si l'id n'est pas connu * **Exemple de résultat:** [assiduite.json](samples/sample_assiduite.json.md) -* +* #### **assiduite-justificatifs[-long]** * **Méthode:** GET * **Permission: `ScoView`** * **Paramètres:** `assiduite_id` -* **Routes:** +* **Routes:** * `/assiduite//justificatifs` * `/assiduite//justificatifs/long` -* **Exemple d'utilisation:** +* **Exemple d'utilisation:** * `/api/assiduite/123/justificatifs` * `/api/assiduite/123/justificatifs/long` * **Résultat:** Retourne une liste de justificatifs. des objets en utilisant la route `long` sinon les justif_id diff --git a/mkdocs.yml b/mkdocs.yml index 0715533e6..c977c620b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,7 +62,7 @@ nav: - "Utilisateurs": UtilisateursScoDoc.md - Développement: - "Guide Développeurs": GuideDeveloppeurs.md - - "Gitea": https://scodoc.org/git + - "Gitea": https://git.scodoc.org - "API": ScoDoc9API.md - "Introduction": DevInternals.md - "Utiliser Git": DevGit.md