feat: Mise à jour de l'index de documentation et suppression des templates génériques
Some checks failed
4NK Template Sync / check-and-sync (push) Has been cancelled
Some checks failed
4NK Template Sync / check-and-sync (push) Has been cancelled
This commit is contained in:
parent
7f8dc0a926
commit
6ced5d2923
156
docs/INDEX.md
156
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** 🚀
|
||||||
|
8
docs/templates/API.md
vendored
8
docs/templates/API.md
vendored
@ -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é
|
|
8
docs/templates/ARCHITECTURE.md
vendored
8
docs/templates/ARCHITECTURE.md
vendored
@ -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
|
|
6
docs/templates/CONFIGURATION.md
vendored
6
docs/templates/CONFIGURATION.md
vendored
@ -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)
|
|
12
docs/templates/INDEX.md
vendored
12
docs/templates/INDEX.md
vendored
@ -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
|
|
7
docs/templates/OPEN_SOURCE_CHECKLIST.md
vendored
7
docs/templates/OPEN_SOURCE_CHECKLIST.md
vendored
@ -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
|
|
29
docs/templates/README.md
vendored
29
docs/templates/README.md
vendored
@ -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)
|
|
7
docs/templates/RELEASE_PLAN.md
vendored
7
docs/templates/RELEASE_PLAN.md
vendored
@ -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)
|
|
7
docs/templates/SECURITY_AUDIT.md
vendored
7
docs/templates/SECURITY_AUDIT.md
vendored
@ -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)
|
|
6
docs/templates/TESTING.md
vendored
6
docs/templates/TESTING.md
vendored
@ -1,6 +0,0 @@
|
|||||||
# Tests — Template
|
|
||||||
|
|
||||||
- Pyramide: unit, integration, connectivity, external, performance
|
|
||||||
- Structure des répertoires
|
|
||||||
- Exécution et rapports
|
|
||||||
- Intégration CI
|
|
7
docs/templates/USAGE.md
vendored
7
docs/templates/USAGE.md
vendored
@ -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)
|
|
@ -96,3 +96,21 @@ pushd "$TARGET_DIR" >/dev/null || true
|
|||||||
popd >/dev/null || true
|
popd >/dev/null || true
|
||||||
|
|
||||||
echo "Agents terminés → $OUTPUT_DIR"
|
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 ==="
|
||||||
|
@ -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
|
apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
|
||||||
|
|
||||||
echo "Dépendances hôte installées."
|
echo "Dépendances hôte installées."
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user