Commit 3ee535a5 authored by Jordan Grossemy's avatar Jordan Grossemy
Browse files

Wiki : documentation Docusaurus publiée sur GitLab Pages 

Site de documentation (docs-site/, Docusaurus) expliquant l'outil :
présentation, concepts, installation, guide animateur (création,
kits & injects, pilotage), guide joueur, administration, référence.
Illustré de captures d'écran réelles de l'application.

- CI GitLab Pages (.gitlab-ci.yml) : build Node 22 + publication.
- webpack épinglé à 5.95.0 (compat. ProgressPlugin de Docusaurus 3.6.3).
- baseUrl déduit de CI_PAGES_URL (portable quel que soit le domaine Pages).
- docs-site exclu de l'image Docker ; caches Docusaurus ignorés.

Co-Authored-By: Claude (RCA)
parent f1cafdb6

.dockerignore

+1 −0
Original line number Diff line number Diff line
@@ -8,3 +8,4 @@ 
.env

.env.local

docs

docs-site

.gitignore

+1 −0
Original line number Diff line number Diff line 
node_modules/

dist/

build/

.docusaurus/

coverage/

*.log

.env

.gitlab-ci.yml

0 → 100644
+24 −0
Original line number Diff line number Diff line 
# Publication du wiki (docs-site, Docusaurus) sur GitLab Pages.

# Le site est construit uniquement depuis la branche par défaut.

pages:

  stage: deploy

  image: node:22.11.0-slim

  rules:

    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

      changes:

        - docs-site/**/*

        - .gitlab-ci.yml

  cache:

    key:

      files:

        - docs-site/package-lock.json

    paths:

      - docs-site/node_modules/

  script:

    - cd docs-site

    - npm ci

    - npm run build

    - mv build ../public

  artifacts:

    paths:

      - public

docs-site/docs/administration.md

0 → 100644
+45 −0
Original line number Diff line number Diff line 
---

sidebar_position: 5

title: Administration

---



# Administration



Les fonctions d'administration sont réservées au rôle **Administrateur** (`TENANT_ADMIN`) de l'organisation. Elles apparaissent dans l'entrée **Utilisateurs** de la navigation.



## Rôles



| Rôle | Droits principaux |

|------|-------------------|

| **TENANT_ADMIN** | Tout : gestion des utilisateurs, exercices, kits ; suppression d'exercice. |

| **DESIGNER** | Concevoir et modifier exercices et kits. |

| **ANIMATOR** | Créer et animer des exercices. |

| **OBSERVER** | Suivre un exercice et prendre des notes (RETEX). |



## Gérer les utilisateurs



Depuis **Utilisateurs**, un administrateur peut :



- **Ajouter un utilisateur** (nom, e-mail, rôle, mot de passe initial) ;

- **Modifier** un utilisateur (nom, e-mail, rôle) ;

- **Réinitialiser le mot de passe** — un mot de passe temporaire est affiché une seule fois, à transmettre à l'utilisateur ;

- **Supprimer** un utilisateur.



:::caution Moindre privilège

Attribuez le rôle le plus restreint suffisant à chaque personne. Réservez `TENANT_ADMIN` à un petit nombre de responsables.

:::



## Archiver et supprimer un exercice



Le cycle recommandé est **Clôturer → Archiver → (éventuellement) Supprimer**.



- **Archiver** conserve l'exercice (consultable, hors des exercices actifs).

- **Supprimer** n'est possible **que sur un exercice archivé**, et **uniquement par un administrateur**. La suppression est **définitive** (elle efface l'exercice et tout son contenu) et demande une confirmation.



:::danger Action irréversible

La suppression d'un exercice archivé ne peut pas être annulée. Assurez-vous d'avoir exporté le RETEX si vous en avez besoin.

:::



## Rétention automatique (RGPD)



Le déploiement peut activer une **purge automatique** des exercices archivés après un nombre de jours défini (`RETENTION_DAYS`). Utile pour limiter la conservation des données d'exercice dans le temps.

docs-site/docs/animateur/creer-un-exercice.md

0 → 100644
+57 −0
Original line number Diff line number Diff line 
---

sidebar_position: 1

title: Créer un exercice

---



# Créer un exercice



Deux points de départ, tous deux dans l'onglet **Exercices** :



- **À partir d'un kit** — le plus courant : on part d'un scénario prêt à l'emploi (bouton **Utiliser ce kit** dans la [Bibliothèque de kits](kits-et-injects.md)).

- **À blanc** — bouton **+ Nouvel exercice**, pour construire son propre scénario.



Dans les deux cas, un **parcours de personnalisation** s'ouvre.



## Le parcours de personnalisation



Le parcours guide la mise en situation en quelques étapes.



![Parcours de création](/img/06-parcours-creation.png)



| Étape | Champs |

|-------|--------|

| **Identité** | Nom de l'exercice, organisation fictive, ville/localisation, secteur. |

| **Apparence** | Thème visuel de l'espace joueur (neutre, Microsoft, Google). |

| **Contexte** | Antivirus/EDR, partenaire/sous-traitant, média/journaliste, date-heure de démarrage. |

| **Récapitulatif** | Vérification, puis création. |



Les valeurs saisies sont conservées comme **contexte de mise en situation** et alimentent le moteur de **variables `{{…}}`** (voir la [Référence](../reference.md)). Sur un kit conçu avec des variables, elles sont **substituées automatiquement** dans le contenu à l'installation.



:::tip

Le champ **organisation** sert de fil rouge : donnez un nom crédible et cohérent avec le secteur choisi, il rendra l'exercice plus immersif.

:::



## Préparer l'exercice



Une fois l'exercice créé, ouvrez-le (**Ouvrir**). L'onglet **Préparation** rassemble les personnages et les accès joueurs.



![Préparation de l'exercice](/img/07-exercice-preparation.png)



Depuis cet écran, vous pouvez :



- **Vérifier les personnages** repris du kit (rôles joueurs et PNJ animés) ;

- **Ajouter / importer des personnages** (import CSV possible) ;

- **Générer un lien d'accès** pour chaque personnage joué par un humain — à transmettre au joueur. Le lien n'est affiché qu'une fois (régénérable si besoin).



:::note

Un personnage sans lien généré est considéré comme **animé par la cellule d'animation** (PNJ).

:::



## Dupliquer



Depuis la liste des exercices, **Dupliquer** crée une copie (personnages inclus, participants exclus, statut remis à *Brouillon*) — pratique pour rejouer un même scénario avec plusieurs groupes.



## Étapes suivantes



- Adapter le contenu : **[Kits & injects](kits-et-injects.md)**

- Lancer et animer : **[Piloter un exercice](piloter-un-exercice.md)**