From 4ed831a2adc765f9513afcf483b83795e7dd4953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9a=20Raya=20D=C3=89CORNOD?= Date: Wed, 22 Jan 2025 16:43:07 +0100 Subject: [PATCH] =?UTF-8?q?d=C3=A9coupage=20en=20plusieurs=20pages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.adoc | 2 - antora-playbook.yml | 4 +- src/docs/antora.yml | 2 + src/docs/modules/ROOT/nav.adoc | 5 + src/docs/modules/ROOT/pages/archi-tech.adoc | 47 ++++++++ src/docs/modules/ROOT/pages/decisions.adoc | 7 ++ src/docs/modules/ROOT/pages/flux.adoc | 64 ++++++++++ src/docs/modules/ROOT/pages/index.adoc | 111 +++++------------- src/docs/modules/ROOT/pages/vocabulaire.adoc | 117 +++++++++++++++++++ 9 files changed, 271 insertions(+), 88 deletions(-) create mode 100644 src/docs/modules/ROOT/nav.adoc create mode 100644 src/docs/modules/ROOT/pages/archi-tech.adoc create mode 100644 src/docs/modules/ROOT/pages/decisions.adoc create mode 100644 src/docs/modules/ROOT/pages/flux.adoc create mode 100644 src/docs/modules/ROOT/pages/vocabulaire.adoc diff --git a/README.adoc b/README.adoc index 3f001e25..15e03b19 100644 --- a/README.adoc +++ b/README.adoc @@ -4,8 +4,6 @@ ESUP STAGE est la refonte de l'application pStage. L'application a été complè link:src/docs/modules/ROOT/pages/index.adoc[→ Documentation technique Esup-Stage] -include::src/docs/modules/ROOT/pages/index.adoc[leveloffset=1] - == Techno * JAVA 11 diff --git a/antora-playbook.yml b/antora-playbook.yml index 849d25b7..88be8e47 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -11,7 +11,7 @@ content: #- develop - feature/* version: - main: '' + #main: '' dev: develop feature/(*): $1 ui: @@ -31,6 +31,7 @@ asciidoc: sourcemap: true attributes: icons: font + page-pagination: '@' appendix-caption: Annexe appendix-refsig: Annexe caution-caption: Attention @@ -50,6 +51,7 @@ asciidoc: table-caption: Tableau tip-caption: Astuce toc-title: Table des matières + page-toctitle: Table des matières untitled-label: Sans titre version-label: Version warning-caption: Avertissement diff --git a/src/docs/antora.yml b/src/docs/antora.yml index fed13a47..c9ba82e3 100644 --- a/src/docs/antora.yml +++ b/src/docs/antora.yml @@ -1,3 +1,5 @@ name: ROOT title: Documentation technique Esup-Stage prerelease: true +nav: +- modules/ROOT/nav.adoc diff --git a/src/docs/modules/ROOT/nav.adoc b/src/docs/modules/ROOT/nav.adoc new file mode 100644 index 00000000..ec55a1b9 --- /dev/null +++ b/src/docs/modules/ROOT/nav.adoc @@ -0,0 +1,5 @@ +* xref::index.adoc[] +* xref::vocabulaire.adoc[] +* xref::decisions.adoc[] +* xref::flux.adoc[] +* xref::archi-tech.adoc[] \ No newline at end of file diff --git a/src/docs/modules/ROOT/pages/archi-tech.adoc b/src/docs/modules/ROOT/pages/archi-tech.adoc new file mode 100644 index 00000000..d0736f69 --- /dev/null +++ b/src/docs/modules/ROOT/pages/archi-tech.adoc @@ -0,0 +1,47 @@ += Architecture de l'application +:author: Université Lorraine +:imagesdir: ../images/ + +[plantuml] +---- +@startuml +skinparam componentStyle rectangle + +Node "Esup - Stage" { + + + + + Node "Frontend" as frontend { + [Angular 18] as angular + [Node 20] as Node + } + + Node "Backend" as backend { + [Spring boot 3.3.4] as spring + [Java 21] as java + } + + +} + + note top of "Esup - Stage" + Tomcat 10 + end note + + +database "Esup-Stage BD" as db { + component "MariaDB" as mariadb +} + +frontend -[hidden]d- backend +backend -[hidden]d- db + +frontend -down-> backend +backend -up-> frontend +backend -down-> db +db -up-> backend + +center footer Architecture de Esup-Stage +@enduml +---- \ No newline at end of file diff --git a/src/docs/modules/ROOT/pages/decisions.adoc b/src/docs/modules/ROOT/pages/decisions.adoc new file mode 100644 index 00000000..8d3b6ab8 --- /dev/null +++ b/src/docs/modules/ROOT/pages/decisions.adoc @@ -0,0 +1,7 @@ += Décisions stratégique +:author: Université Lorraine +:imagesdir: ../images/ + +**** +Un stage a toujours une convention +**** diff --git a/src/docs/modules/ROOT/pages/flux.adoc b/src/docs/modules/ROOT/pages/flux.adoc new file mode 100644 index 00000000..37ae622e --- /dev/null +++ b/src/docs/modules/ROOT/pages/flux.adoc @@ -0,0 +1,64 @@ += Flux +:author: Université Lorraine +:imagesdir: ../images/ + +== Flux Entrant + +=== Application de signature électronique + +.Messages +** PDF *signés* +*** Convention +*** Avenant + +.Systèmes (1 seul au choix, configuration) +* Esup-signature ou _autre_ +** API serveur et client dans une séquence +CAUTION: Lien vers doc(s) à trouver _svp_ +* Docaposte +** [JAX-RS client, WSDL] + +==== Esup-Signature (ou _autre_) + +WARNING: la séquence de communication plus compliquée +que le schéma *_très_* simplifié ci dessous. +[plantuml] +.... + +card esup_signature as "Esup Signature" +card esup_stage as "Esup Stage" + +esup_signature "🖺" <-0)- esup_stage +esup_signature -(0-> "📃" esup_stage +.... + + +=== Esup-siscol + +[plantuml] +.... +left to right direction + +card etudiant_inscrit as "Étudiant inscrit\n(Apogée)" +card esup_siscol as "Esup SISCOL" +card esup_stage as "Esup Stage" + +etudiant_inscrit <-0)- esup_siscol: "WS Apogée" +esup_siscol <-0)- esup_stage +.... + + +== Flux Sortant + +=== Application de signature (_c.f._ flux entrant) + +** PDF *à signer* +*** Convention +*** Avenant + +.Systèmes (1 seul au choix, configuration) +* Esup-signature ou _autre_ +** API serveur et client dans une séquence +CAUTION: Lien vers doc(s) à trouver _svp_ +* Docaposte +** [JAX-RS client, WSDL] diff --git a/src/docs/modules/ROOT/pages/index.adoc b/src/docs/modules/ROOT/pages/index.adoc index 5295ce01..fa762b2f 100644 --- a/src/docs/modules/ROOT/pages/index.adoc +++ b/src/docs/modules/ROOT/pages/index.adoc @@ -1,88 +1,29 @@ = Documentation technique Esup-Stage :author: Université Lorraine :imagesdir: ../images/ - - -== Vocabulaire du domaine - -Stage:: #TODO# -Convention (lié à un centre de gestion via les critères):: #TODO# -PDF Convention:: #TODO# -Centre de gestion:: #TODO# -Validation administrative:: #TODO# -Validation pédagogique:: #TODO# -Signature de la Convention:: #TODO# -Avenant:: #TODO# -PDF Avenant:: #TODO# -Évaluation de stage:: #TODO# -Modèle de convention:: #TODO# -Modèle d’avenant:: #TODO# -Modèle de mail:: #TODO# -Etablissement d’accueil:: #TODO# -Etape : VET:: #TODO# -UFR:: #TODO# -Critères de gestion:: #TODO# -Type de convention:: #TODO# - -== Décisions Stratégique - -* Un stage a toujours une convention - -== Flux -=== Flux Entrant - -==== Application de signature électronique - -.Messages -** PDF *signés* -*** Convention -*** Avenant - -.Systèmes (1 seul au choix, configuration) -* Esup-signature ou _autre_ -** API serveur et client dans une séquence -CAUTION: Lien vers doc(s) à trouver _svp_ -* Docaposte -** [JAX-RS client, WSDL] - - -==== Esup-siscol - -[plantuml] -.... -left to right direction -card e_ins as "Étudiant inscrit\n(Apogée)" -card esup_siscol as "Esup-siscol" -card esup_stage as "Esup-Stage" -e_ins <-0)- esup_siscol: "WS Apogée" -esup_siscol <-0)- esup_stage -.... - -//'@startuml -//'card e_ins as "Étudiant inscrit (Apogée)" -//' -//'interface ws_apo as "WS Apogée" -//' -//'card siscol as Esup-siscol -//' -//'e_ins -> ws_apo -//' -//'' Etudiant inscrit (Apogée) ← WS Apogée← Esup-siscol ← Esup-Stage -//'@enduml - - -=== Flux Sortant - -==== Application de signature (_c.f._ flux entrant) - -** PDF *à signer* -*** Convention -*** Avenant - -.Systèmes (1 seul au choix, configuration) -* Esup-signature ou _autre_ -** API serveur et client dans une séquence -CAUTION: Lien vers doc(s) à trouver _svp_ -* Docaposte -** [JAX-RS client, WSDL] - +:reftext: Documentation technique +:navtitle: Documentation technique + +**** +ESUP-Stage est l'application qui permet aux étudiants de créer et faire signer +leur(s) convention(s) de stage. Développée dans une technologie moderne, cette +solution est prévue pour s'interconnecter avec l'annuaire LDAP des +établissements ainsi qu'Apogée dans un premier temps. Des travaux sont en cours +avec les équipes PC-Scol pour assurer une compatibilité avec Pégase. + +* Interface utilisateur modernisée, +* facilité de configuration de l'application selon les besoins de chaque +établissement, +* gestion fine des droits d'utilisateur, +* matérialisation des étapes de création d'une convention ergonomique. +* Par ailleurs, le périmètre d'utilisation de l'application s'élargit en +permettant son utilisation par les INSPÉ avec notamment la possibilité +de créer des conventions de stage en masse. +* Ouverture vers la dématérialisation des signatures +* La dématérialisation du processus de création et validation des conventions est au cœur des préoccupations du groupe de travail œuvrant pour le développement et l'évolution de ESUP-Stage. Aussi arrivera prochainement la possibilité d'interfacer via un webservice la solution ESUP-Signature ou toute solution commerciale compatible. +**** + +== xref:vocabulaire.adoc[] +== xref:decisions.adoc[] +== xref:flux.adoc[] +== xref:archi-tech.adoc[] diff --git a/src/docs/modules/ROOT/pages/vocabulaire.adoc b/src/docs/modules/ROOT/pages/vocabulaire.adoc new file mode 100644 index 00000000..58e244a0 --- /dev/null +++ b/src/docs/modules/ROOT/pages/vocabulaire.adoc @@ -0,0 +1,117 @@ += Vocabulaire du domaine de Esup-Stage +:author: Université Lorraine +:imagesdir: ../images/ +:reftext: Vocabulaire +:navtitle: Vocabulaire + +Établissement:: Organisme d'enseignement ou formation +qui gère administrativement les stages dans l'application Esup-Stage. + +Stage:: +est effectué par un étudiant dans un établissement d’accueil pour une durée +limitée. ++ +TIP: Dans l'application, +c'est la convention qui articule la gestion administrative du stage. + +Convention (de stage):: +description administrative d'un stage qui définit les responsabilités des +différentes parties, en général adossé à un document écrit contractuel. +Les données saisies pour la convention sont utilisées +pour le suivi administratif du stage. ++ +TIP: Est liée à un centre de gestion via les critères du centre de gestion. + +Validation::: +* S’il s’agit d’une convention saisie par l’étudiant, la convention est validée +selon le paramétrage effectué au niveau du centre de gestion. +* S’il s’agit d’une +convention issue d’une création en masse par le gestionnaire, elle est déjà validée. +Suivant le paramétrage défini dans centre de gestion : #TODO: À PRÉCISER MIEUX s.v.p.# +Validation pédagogique:::: #TODO: À DÉFINIR# +Validation administrative:::: #TODO: À DÉFINIR# + +PDF Convention::: document écrit dématérialisé de la convention de stage (a +vocation à être signé). ++ +TIP: il est définitif une fois signé. + +Signature de la Convention:::: #TODO: À DÉFINIR# +Type de convention::: #TODO: À DÉFINIR# + +Avenant::: #TODO: À DÉFINIR# +Validation de l'avenant:::: #TODO: À DÉFINIR# +PDF Avenant:::: document écrit dématérialisé d'un avenant à la convention +(a vocation à être signé aussi). #TODO: À PRÉCISER UN PEU PLUS# + +Etablissement d’accueil::: +entreprise, administration, établissement scolaire, association ou tout autre +organisme amené à accueillir des étudiants en stage. + +Enseignant référent pour le stage::: l’enseignant référent est un enseignant de +l’Université responsable du stage. Il s’agit souvent de l’enseignant responsable +de l’étape (ou de la formation). Il est habilité à consulter tous les rapports +déposés (rapports de visites et rapport du tuteur professionnel) pour les stages +dont il est responsable. +Tuteur professionnel::: le tuteur appartient à l’établissement d’accueil. Il +n’accède pas à l’application ESUP-Stage. Il ne dispose pas nécessairement d’un +compte à l’université. Il n’accède pas à l’application ESUP-Stage. + +Étudiant:: de l’université inscrit à au moins une version d’étape +et pouvant effectuer des stages facultatifs ou obligatoires. +Groupe:: groupe d’étudiants *créé dans l'application* +à partir d’une sélection d’étudiants. + +Évaluation de stage:: #TODO: À DÉFINIR# + +Centre de gestion:: est une entité de l'établissement qui : +* regoupe un ensemble d’utilisateurs qui a la charge de gérer les stages +d’une partie de l’établissement : les gestionnaires. +* est associé à des étapes via des critères : +Critères de gestion::: un centre de gestion peut être associé +au niveau d'une UFR ou au niveau d'une étape. +Etape : VET (version d'étape):::: +fractionnement dans le temps d’un enseignement +conduisant éventuellement à un diplôme. + +Issue d’APOGEE. +UFR:::: Composante ou Unité de formation de l'établissement. +Gestionnaire (de scolarité)::: +utilisateur actuellement habilité dans ESUP-Stage à gérer les stages pour un ou plusieurs centres de gestion. + +Modèles:: +Paramétrables dans l'application avec des champs +-- substitués à l'édition (ou l'envoi) -- +qui peuvent être placés dans du texte enrichi. + +Modèle de convention::: +Définit l'édition du PDF de la convention. ++ +[TIP] +.Pour les fonctionnaires stagiaires : +==== +un INSPÉ créera un modèle de convention « INSPÉ stage sans convention ». +Ainsi même s’il n’y a pas de convention écrite pour le(s) stage(s), +ce modèle vide pourra être utilisé. +==== + +Modèle d’avenant::: Définit l'édition du PDF d'un avenant. + +Modèle de mail::: Définit les message de notifications par courriel. + +== À Classer (ou supprimer) + +Conventions en masse:: facilité de gestion administrative de création des +conventions par groupe d’étudiants quand la mise en stage est effectuée par les +gestionnaires. Le template de convention est actuellement choisi pour chaque +groupe. +Enseignant additionnel (?????):: +enseignants de l’Université disposant des mêmes droits de consultation que l’enseignant référent. +Responsable de scolarité (?????):: utilisateur actuellement habilité à gérer un ou +plusieurs centres de gestion et son paramétrage. ++ +[TIP] +.A l’INSPÉ, +==== +les responsables de bureau 1er degré et 2nd degré +seront déclarés responsables de scolarité. +====