From 4677d16a997e2768b2e50ad3351789392dde8a58 Mon Sep 17 00:00:00 2001
From: marcchevaldonne <marc.chevaldonne@uca.fr>
Date: Wed, 22 Nov 2023 13:20:05 +0100
Subject: [PATCH] :memo: specs

---
 ReadMe.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 ReadMe.md

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..d5fe325
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,64 @@
+# codefirst v2 - spécifications
+Voici la liste des caractéristiques que nous souhaitons mettre en place dans codefirst v2.
+
+Le code de la v2 sera open-source prochainement. Si vous souhaitez participer dès maintenant, merci de me contacter.
+
+## authentification
+- keycloak
+- (comme sur la v1)
+- branché au LDAP de l'UCA
+
+## git intégré
+- à travers GitLab
+- (à la place de gitea)
+
+## gestion du pipeline de CI/CD
+- à travers GitLab  
+- (à la place de Drone)
+- en utilisant ```.gitlab-ci.yml```
+
+## analyseur de code
+- SonarQube
+- (comme sur la v1)
+
+## gestion de projets
+- gestion de tickets (via gitlab)
+- gestion par projet (Kanban)
+
+## hébergement de documentation
+1. documentation privée par dépôt (GitLab pages)
+2. documentation publique et partagée (pour les cours par exemple) via le déploiement de conteneur
+3. ?? documentation accessible par authentification avec gestion des personnes autorisées ??
+
+## déploiement des conteneurs et hébergement
+- solution maison
+- basée sur docker et kubernetes
+
+## gestion des utilisateurs et des groupes
+- utilisateurs et groupes directement remontés depuis Odin
+- possibilité d'ajouter des utilisateurs externes (vacataires non encore répertoriés, partenaires externes...)
+
+## portail développeur
+### utilisateur
+- possibilité d'ajouter des tickets sur code first en général (bugs report, demande de features, demande de doc)
+- possibilité de demander plus d'espace
+- possibilité de voir ses conteneurs
+- ? possibilité de relancer ses conteneurs ? (il peut déjà le faire en relançant son pipeline)
+- possibilité de tuer ses conteneurs
+### admin
+- possibilité de tuer les conteneurs de n'importe qui
+- possibilité de voir tous les conteneurs
+- possibilité de relancer n'importe quel conteneur
+- allouer plus d'espace à un utilisateur
+
+## installation 
+- code open-source et accessible sous GitHub
+- doc pour installer et relancer code first
+
+## doc utilisateur
+- documentation pour tous
+- (comme sur la v1)
+- hébergerment de cours (comme sur la v1)
+
+## migration de code first v1 vers code first v2
+- les dépôts et comptes seront automatiquement migrés de la v1 vers la v2