From 6ced5d29231b711bd0c8eab591091c810d0147d7 Mon Sep 17 00:00:00 2001 From: Debian Date: Fri, 29 Aug 2025 16:29:55 +0000 Subject: [PATCH] =?UTF-8?q?feat:=20Mise=20=C3=A0=20jour=20de=20l'index=20d?= =?UTF-8?q?e=20documentation=20et=20suppression=20des=20templates=20g?= =?UTF-8?q?=C3=A9n=C3=A9riques?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/INDEX.md | 156 +++++++++++++++++++++++- docs/templates/API.md | 8 -- docs/templates/ARCHITECTURE.md | 8 -- docs/templates/CONFIGURATION.md | 6 - docs/templates/INDEX.md | 12 -- docs/templates/OPEN_SOURCE_CHECKLIST.md | 7 -- docs/templates/README.md | 29 ----- docs/templates/RELEASE_PLAN.md | 7 -- docs/templates/SECURITY_AUDIT.md | 7 -- docs/templates/TESTING.md | 6 - docs/templates/USAGE.md | 7 -- scripts/agents/run.sh | 18 +++ scripts/local/install_host_deps.sh | 1 + 13 files changed, 174 insertions(+), 98 deletions(-) delete mode 100644 docs/templates/API.md delete mode 100644 docs/templates/ARCHITECTURE.md delete mode 100644 docs/templates/CONFIGURATION.md delete mode 100644 docs/templates/INDEX.md delete mode 100644 docs/templates/OPEN_SOURCE_CHECKLIST.md delete mode 100644 docs/templates/README.md delete mode 100644 docs/templates/RELEASE_PLAN.md delete mode 100644 docs/templates/SECURITY_AUDIT.md delete mode 100644 docs/templates/TESTING.md delete mode 100644 docs/templates/USAGE.md diff --git a/docs/INDEX.md b/docs/INDEX.md index 2061bac..a700039 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -1,2 +1,156 @@ -# Index +# 📚 Index de Documentation - 4NK_template +Index complet de la documentation du template 4NK pour la création de nouveaux projets. + +## 🚀 Vue d'Ensemble + +4NK_template est un template complet pour créer de nouveaux projets dans l'écosystème 4NK. Il fournit une structure standardisée avec tous les éléments nécessaires pour un projet open source moderne. + +## 📖 Guides Principaux + +### 🚀 [Guide d'Installation](INSTALLATION.md) +Guide complet pour installer et configurer un nouveau projet basé sur 4NK_template. +- **Prérequis système et logiciels** +- **Installation du template** +- **Configuration initiale** +- **Personnalisation du projet** +- **Tests post-installation** + +### 📖 [Guide d'Utilisation](USAGE.md) +Guide complet pour utiliser le template et créer de nouveaux projets. +- **Création d'un nouveau projet** +- **Personnalisation de la structure** +- **Configuration des scripts** +- **Adaptation de la documentation** +- **Tests et validation** + +### ⚙️ [Guide de Configuration](CONFIGURATION.md) +Guide complet pour configurer le template selon vos besoins. +- **Configuration générale** +- **Personnalisation des scripts** +- **Configuration CI/CD** +- **Configuration Docker** +- **Configuration de sécurité** + +## 🔧 Guides Techniques + +### 🏗️ [Architecture Technique](ARCHITECTURE.md) +Documentation technique détaillée de l'architecture du template. +- **Structure générale du template** +- **Composants principaux** +- **Scripts et utilitaires** +- **Configuration Docker** +- **Intégration CI/CD** +- **Sécurité et bonnes pratiques** + +### 📡 [API Reference](API.md) +Documentation des APIs et interfaces du template. +- **Scripts disponibles** +- **Configuration des hooks Git** +- **Variables d'environnement** +- **Format des fichiers de configuration** + +### 🔒 [Sécurité](SECURITY.md) +Guide de sécurité et bonnes pratiques. +- **Audit de sécurité** +- **Bonnes pratiques** +- **Configuration sécurisée** +- **Tests de sécurité** + +## 🧪 Guides de Test + +### 🧪 [Guide des Tests](TESTING.md) +Guide complet pour les tests du template. +- **Tests unitaires** +- **Tests d'intégration** +- **Tests de sécurité** +- **Tests de configuration** + +### 🔍 [Audit de Sécurité](SECURITY_AUDIT.md) +Audit de sécurité détaillé du template. +- **Vulnérabilités connues** +- **Tests de pénétration** +- **Audit de code** +- **Recommandations de sécurité** + +## 🔧 Guides de Développement + +### 🔧 [Guide de Développement](DEVELOPMENT.md) +Guide complet pour le développement avec le template. +- **Environnement de développement** +- **Workflow de développement** +- **Standards de code** +- **Debugging et profiling** +- **Optimisation des performances** + +## 📊 Déploiement + +### 🚀 [Guide de Déploiement](DEPLOYMENT.md) +Guide complet pour déployer des projets basés sur le template. +- **Configuration de production** +- **Déploiement Docker** +- **Intégration CI/CD** +- **Monitoring et observabilité** + +## 🎯 Navigation Rapide + +### 🚀 Démarrage Rapide +1. [Installation](INSTALLATION.md) - Installer le template +2. [Configuration](CONFIGURATION.md) - Configurer le projet +3. [Utilisation](USAGE.md) - Créer un nouveau projet + +### 🔧 Développement +1. [Architecture](ARCHITECTURE.md) - Comprendre l'architecture +2. [API](API.md) - Consulter les APIs +3. [Tests](TESTING.md) - Exécuter les tests + +### 📚 Documentation +1. [Index](INDEX.md) - Cet index +2. [Déploiement](DEPLOYMENT.md) - Guide de déploiement + +--- + +## 🧪 Tests et Validation + +### Tests Automatisés +```bash +# Tests du template +./scripts/test-template.sh + +# Tests de configuration +./scripts/test-config.sh + +# Tests de sécurité +./scripts/security-audit.sh +``` + +--- + +## 🚀 Développement + +### Commandes Essentielles +```bash +# Créer un nouveau projet +./scripts/create-project.sh my-new-project + +# Configurer un projet existant +./scripts/setup-project.sh + +# Tests du template +./scripts/test-template.sh +``` + +--- + +## 📊 Métriques + +### Fonctionnalités +- **Structure standardisée** : ✅ Complète +- **Scripts automatisés** : ✅ Disponibles +- **Configuration CI/CD** : ✅ Intégrée +- **Documentation** : ✅ Template complet +- **Tests** : ✅ Automatisés + +--- + +**📚 Documentation complète pour 4NK_template - Template pour nouveaux projets 4NK** 🚀 diff --git a/docs/templates/API.md b/docs/templates/API.md deleted file mode 100644 index 431560f..0000000 --- a/docs/templates/API.md +++ /dev/null @@ -1,8 +0,0 @@ -# Référence API — Template - -- Vue d’ensemble -- Authentification/permissions -- Endpoints par domaine (schémas, invariants) -- Codes d’erreur -- Limites et quotas -- Sécurité et conformité diff --git a/docs/templates/ARCHITECTURE.md b/docs/templates/ARCHITECTURE.md deleted file mode 100644 index 42b78b2..0000000 --- a/docs/templates/ARCHITECTURE.md +++ /dev/null @@ -1,8 +0,0 @@ -# Architecture — Template - -- Contexte et objectifs -- Découpage en couches (UI, services, données) -- Flux principaux -- Observabilité -- CI/CD -- Contraintes et SLA diff --git a/docs/templates/CONFIGURATION.md b/docs/templates/CONFIGURATION.md deleted file mode 100644 index 3506069..0000000 --- a/docs/templates/CONFIGURATION.md +++ /dev/null @@ -1,6 +0,0 @@ -# Configuration — Template - -- Variables d’environnement (nom, type, défaut, portée) -- Fichiers de configuration (format, validation) -- Réseau et sécurité (ports, TLS, auth) -- Observabilité (logs, métriques, traces) diff --git a/docs/templates/INDEX.md b/docs/templates/INDEX.md deleted file mode 100644 index be566c0..0000000 --- a/docs/templates/INDEX.md +++ /dev/null @@ -1,12 +0,0 @@ -# Index — Templates de documentation (pour projets dérivés) - -Utilisez ces squelettes pour démarrer la documentation de votre projet. - -- API.md — squelette de référence API -- ARCHITECTURE.md — squelette d’architecture -- CONFIGURATION.md — squelette de configuration -- USAGE.md — squelette d’usage -- TESTING.md — squelette de stratégie de tests -- SECURITY_AUDIT.md — squelette d’audit sécurité -- RELEASE_PLAN.md — squelette de plan de release -- OPEN_SOURCE_CHECKLIST.md — squelette de checklist open source diff --git a/docs/templates/OPEN_SOURCE_CHECKLIST.md b/docs/templates/OPEN_SOURCE_CHECKLIST.md deleted file mode 100644 index 8406e38..0000000 --- a/docs/templates/OPEN_SOURCE_CHECKLIST.md +++ /dev/null @@ -1,7 +0,0 @@ -# Checklist open source — Template - -- Gouvernance: LICENSE, CONTRIBUTING, CODE_OF_CONDUCT -- CI/CD: workflows, tests, security-audit, release-guard -- Documentation: README, INDEX, guides essentiels -- Sécurité: secrets, permissions, audit -- Publication: tag, changelog, release notes diff --git a/docs/templates/README.md b/docs/templates/README.md deleted file mode 100644 index fe4d4bb..0000000 --- a/docs/templates/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# README — Template de projet - -## Présentation - -Décrivez brièvement l’objectif du projet, son périmètre et ses utilisateurs cibles. - -## Démarrage rapide - -- Prérequis (langages/outils) -- Étapes d’installation -- Commandes de démarrage - -## Documentation - -- Index: `docs/INDEX.md` -- Architecture: `docs/ARCHITECTURE.md` -- Configuration: `docs/CONFIGURATION.md` -- Tests: `docs/TESTING.md` -- Sécurité: `docs/SECURITY_AUDIT.md` -- Déploiement: `docs/DEPLOYMENT.md` - -## Contribution - -- GUIDE: `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md` -- Processus de PR et revues - -## Licence - -- Indiquez la licence choisie (MIT/Apache-2.0/GPL) diff --git a/docs/templates/RELEASE_PLAN.md b/docs/templates/RELEASE_PLAN.md deleted file mode 100644 index ab912bf..0000000 --- a/docs/templates/RELEASE_PLAN.md +++ /dev/null @@ -1,7 +0,0 @@ -# Plan de release — Template - -- Vue d’ensemble, objectifs, date cible -- Préparation (docs/CI/tests/sécurité) -- Communication (annonces, canaux) -- Lancement (checklist, tagging) -- Post‑lancement (support, retours) diff --git a/docs/templates/SECURITY_AUDIT.md b/docs/templates/SECURITY_AUDIT.md deleted file mode 100644 index 3876d6a..0000000 --- a/docs/templates/SECURITY_AUDIT.md +++ /dev/null @@ -1,7 +0,0 @@ -# Audit de sécurité — Template - -- Menaces et surfaces d’attaque -- Contrôles préventifs et détectifs -- Gestion des secrets -- Politique de dépendances -- Vérifications CI (security-audit) diff --git a/docs/templates/TESTING.md b/docs/templates/TESTING.md deleted file mode 100644 index 81a4b51..0000000 --- a/docs/templates/TESTING.md +++ /dev/null @@ -1,6 +0,0 @@ -# Tests — Template - -- Pyramide: unit, integration, connectivity, external, performance -- Structure des répertoires -- Exécution et rapports -- Intégration CI diff --git a/docs/templates/USAGE.md b/docs/templates/USAGE.md deleted file mode 100644 index 8cad2e9..0000000 --- a/docs/templates/USAGE.md +++ /dev/null @@ -1,7 +0,0 @@ -# Usage — Template - -- Démarrage quotidien -- Opérations courantes -- Tests (référence vers TESTING.md) -- Sécurité (référence vers SECURITY_AUDIT.md) -- Déploiement (référence vers DEPLOYMENT.md) diff --git a/scripts/agents/run.sh b/scripts/agents/run.sh index 9b9cf9c..4940d62 100755 --- a/scripts/agents/run.sh +++ b/scripts/agents/run.sh @@ -96,3 +96,21 @@ pushd "$TARGET_DIR" >/dev/null || true popd >/dev/null || true echo "Agents terminés → $OUTPUT_DIR" + +# Affichage des rapports générés +echo +echo "=== RAPPORTS GÉNÉRÉS ===" +if [[ -d "$OUTPUT_DIR" ]]; then + for report in "$OUTPUT_DIR"/*.md; do + if [[ -f "$report" ]]; then + echo + echo "📄 $(basename "$report"):" + echo "----------------------------------------" + cat "$report" + echo "----------------------------------------" + fi + done +else + echo "Aucun rapport généré dans $OUTPUT_DIR" +fi +echo "=== FIN DES RAPPORTS ===" diff --git a/scripts/local/install_host_deps.sh b/scripts/local/install_host_deps.sh index f35d386..601aac8 100755 --- a/scripts/local/install_host_deps.sh +++ b/scripts/local/install_host_deps.sh @@ -19,3 +19,4 @@ apt install -y dos2unix rsync direnv git curl vim tree sed net-tools iproute2 pr apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin echo "Dépendances hôte installées." +