Skip to content

Commit

Permalink
découpage en plusieurs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
lea-raya authored and Léa Raya DÉCORNOD committed Jan 22, 2025
1 parent adab849 commit 4ed831a
Show file tree
Hide file tree
Showing 9 changed files with 271 additions and 88 deletions.
2 changes: 0 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ content:
#- develop
- feature/*
version:
main: ''
#main: ''
dev: develop
feature/(*): $1
ui:
Expand All @@ -31,6 +31,7 @@ asciidoc:
sourcemap: true
attributes:
icons: font
page-pagination: '@'
appendix-caption: Annexe
appendix-refsig: Annexe
caution-caption: Attention
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
name: ROOT
title: Documentation technique Esup-Stage
prerelease: true
nav:
- modules/ROOT/nav.adoc
5 changes: 5 additions & 0 deletions src/docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* xref::index.adoc[]
* xref::vocabulaire.adoc[]
* xref::decisions.adoc[]
* xref::flux.adoc[]
* xref::archi-tech.adoc[]
47 changes: 47 additions & 0 deletions src/docs/modules/ROOT/pages/archi-tech.adoc
Original file line number Diff line number Diff line change
@@ -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
----
7 changes: 7 additions & 0 deletions src/docs/modules/ROOT/pages/decisions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= Décisions stratégique
:author: Université Lorraine
:imagesdir: ../images/

****
Un stage a toujours une convention
****
64 changes: 64 additions & 0 deletions src/docs/modules/ROOT/pages/flux.adoc
Original file line number Diff line number Diff line change
@@ -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]
111 changes: 26 additions & 85 deletions src/docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Loading

0 comments on commit 4ed831a

Please sign in to comment.