Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Projet FreeBSD
- Rédacteur technique:
- Larry
- Nom du projet:
- Mises à jour des manuels FreeBSD
- Durée du projet:
- Longue durée (cinq mois)
Project description
Ce projet GSoD2020 comprendra deux chapitres dans les manuels FreeBSD:
- Test: nouveau chapitre du manuel du développeur FreeBSD
- LDAP: article mis à jour fusionné avec un chapitre du manuel FreeBSD
Tests: nouveau chapitre du manuel du développeur FreeBSD:
REMARQUE: Ce projet est plus exploratoire au début. Les exigences peuvent changer au cours de la phase de rédaction.
Les tâches de préparation incluent les suivantes : * Consulter la documentation actuelle et les notes sur les frameworks de test pour les développeurs, les pratiques, etc. pour FreeBSD et d'autres BSD * Documentation et notes FreeBSD actuelles ou plus anciennes. Par exemple : * TestSuite: https://wiki.freebsd.org/TestSuite * Ancienne page "TestingFreeBSD" : https://wiki.freebsd.org/TestingFreeBSD * Documentation à jour et notes sur les projets associés. Par exemple : * http://wiki.netbsd.org/tutorials/atf/ * Documentation principale des outils concernés. Par exemple : * Framework de test Kyua: https://github.com/jmmv/kyua/ * Framework de test automatisé (ATF): https://github.com/jmmv/atf/ * Installation et configuration des frameworks pertinents pour vous familiariser avec eux. * Utiliser les frameworks de test pour exécuter les tests en cours. * Écrire un petit nombre de nouveaux tests. * (TRÈS important) Consulter les lecteurs (développeurs et testeurs de logiciels) sur ce qu'ils souhaitent voir dans le chapitre.
L'organisation exacte de la documentation reste à déterminer. Toutefois, après avoir lu ce chapitre, le lecteur doit être capable de faire au moins ce qui suit:
- Installer et configurer les frameworks de test pour tester FreeBSD
- Écrivez un test pour le framework de test.
- Exécutez un test dans le framework de test.
Les points suivants seront mis en avant dans la mesure du possible : * Maximiser l'automatisation pour réduire le travail de configuration de l'infrastructure de test, d'écriture et d'exécution des tests. * Ajout de cas de test chaque fois qu'un bug est corrigé. * des tests de régression automatisés complets. * Le cas échéant, elle présente des exemples de scénarios de test standards, tels que les tests unitaires, fonctionnels, de charge, etc.
Dans la mesure du possible, l'objectif est non seulement d'expliquer et de guider le développeur dans le framework de test, mais aussi de simplifier le processus autant que possible afin d'encourager les développeurs à effectuer davantage de tests et de ne pas décourager les nouveaux développeurs de contribuer.
LDAP: article mis à jour fusionné dans le chapitre du manuel FreeBSD:
Contrairement au chapitre sur les tests, le champ d'application d'un article ou d'un chapitre mis à jour sur LDAP est bien compris.
Le chapitre actuel du manuel FreeBSD et cet article contiennent de nombreuses informations utiles. Toutefois, elles doivent être mises à jour. Une nouvelle révision de l'article, destinée à devenir le nouveau chapitre, a été lancée, mais doit être finalisée.
Les tâches à accomplir incluent les suivantes : * Correction du chapitre et de l'article actuels du manuel. * En préparation du GSoD2020, une première vérification a été effectuée. * Tester chaque section du manuel pour vérifier ce qui fonctionne et ce qui doit être révisé. * En prévision du GSoD 2020, la configuration du serveur a été testée et des améliorations ont été identifiées. * Autres sections restantes. * Écrire de nouveaux contenus et réviser les contenus existants. * Le contenu de la section sur le serveur a commencé à être mis à jour. Il doit être terminé. * Autres sections restantes. * Tester l'ensemble du contenu sur des systèmes FreeBSD propres une fois la version finale terminée. * Cette tâche est essentielle, car elle permet d'identifier les lacunes.
Le dernier chapitre de l'article ou du manuel doit contenir les sections suivantes:
(1) Présentation de LDAP (2) Configuration du serveur (a) Présentation détaillée d'une configuration de serveur OpenLDAP de base, mais fonctionnelle, sur FreeBSD. (b) Un exemple complet de configuration de serveur OpenLDAP basique, mais fonctionnelle, par exemple le résultat de (2a), sur FreeBSD.
""Basique, mais fonctionnel"" inclut la configuration du serveur avec des mots de passe hachés, des connexions sécurisées sur le réseau et des exemples de données utilisateur simulées, mais représentatives.
(Facultatif : à décider lors du GSoD2020) La configuration du serveur peut également inclure une couverture équivalente de 389 Directory Server sous FreeBSD. La compatibilité expérimentale avec FreeBSD était disponible dans 389 Directory Server, mais son état actuel doit être confirmé.
(3) Configuration du client : (a) Explication détaillée d'une configuration client fonctionnelle sur FreeBSD pouvant se connecter à l'exemple de connexion au serveur fourni en (2). (b) Un exemple complet de configuration client fonctionnelle, par exemple le résultat de (3a), sur FreeBSD.
La section de configuration du client comprendra des sous-sections sur les éléments suivants : * PAM (Pluggable Authentication Module), par exemple pam_ldap, pam_mkhomedir, nss-pam-ldapd * NSS (Name Service Switch), par exemple nss_ldap, nss-pam-ldapd * (Facultatif, à décider lors du GSoD2020) SSSD : l'état de SSSD en production dans FreeBSD doit être confirmé. * (Facultatif, à décider lors du GSoD2020) FreeIPA : l'utilisation et les fonctionnalités de FreeIPA dans FreeBSD doivent être étudiées. FreeIPA ne se limite pas à LDAP. Par conséquent, vous devez évaluer la portée de la configuration FreeIPA avant de l'inclure dans ce chapitre du manuel.
(4) Considérations de sécurité * La version actuelle de l'article inclut une section sur les considérations de sécurité. Certains de ces contenus peuvent être déplacés vers la section appropriée. Toutefois, une section dédiée aux considérations de sécurité doit toujours être incluse à des fins de référence.
(5) Dépannage * Stratégies de dépannage de la configuration LDAP
(6) Annexe OpenSSL
Avec le chapitre / article mis à jour du manuel, le lecteur peut prendre deux systèmes FreeBSD propres, configurer un serveur LDAP et un client LDAP, puis authentifier le client auprès du serveur.
Après avoir lu le chapitre ou l'article mis à jour du manuel, le lecteur doit disposer des bases nécessaires pour consulter d'autres documentations plus spécialisées ou plus complètes, par exemple la documentation OpenLDAP, les RFC LDAP, et créer ou affiner sa configuration LDAP FreeBSD pour répondre à ses besoins.