Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- The FreeBSD Project
- Redattore tecnico:
- Larry
- Nome del progetto:
- Aggiornamenti ai manuali di FreeBSD
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Questo progetto GSoD2020 sarà composto da due capitoli dei manuali di FreeBSD:
- Test: nuovo capitolo nel Manuale per gli sviluppatori FreeBSD
- LDAP: articolo aggiornato unito al capitolo nel Manuale di FreeBSD
Test: nuovo capitolo nel Manuale per sviluppatori FreeBSD:
NOTA: questo progetto è più esplorativo all'inizio. I requisiti possono cambiare durante la fase di scrittura.
Le attività di preparazione includono: * la revisione della documentazione e delle note attuali su framework, pratiche e così via per i test degli sviluppatori per FreeBSD e altri BSD. * Documentazione e note attuali o precedenti di FreeBSD. Ad esempio: * TestSuite: https://wiki.freebsd.org/TestSuite * Pagina ""TestingFreeBSD" precedente: https://wiki.freebsd.org/TestingFreeBSD * Documentazione attuale e note di progetti correlati. Ad esempio: * http://wiki.netbsd.org/tutorials/atf/ * Documentazione principale degli strumenti coinvolti. Ad esempio: * Framework di test Kyua: https://github.com/jmmv/kyua/ * Automated Testing Framework (ATF): https://github.com/jmmv/atf/ * Installazione e configurazione dei framework pertinenti per acquisire familiarità. * Usare i framework di test per eseguire i test attuali. * Scrivere un numero limitato di nuovi test. * (Molto importante) Consultare i lettori (sviluppatori di software e tester) su ciò che vogliono vedere nel capitolo.
È necessario determinare l'organizzazione esatta della documentazione. Tuttavia, dopo aver letto il capitolo, il lettore dovrebbe essere in grado di svolgere almeno le seguenti operazioni:
- Installa e configura i framework di test per testare FreeBSD.
- Scrivi un test per il framework di test.
- Esegui un test nel framework di test.
Ove possibile, verranno messi in evidenza i seguenti aspetti: * massimizzazione dell'automazione per ridurre il lavoro di configurazione dell'infrastruttura di test, scrittura dei test ed esecuzione dei test. * Aggiunta di casi di test ogni volta che viene corretto un nuovo bug. * Test di regressione automatica completi. * (ove applicabile) che fornisce esempi di scenari di test standard, come test delle unità, test funzionali, test di carico e così via.
Ove possibile, l'obiettivo è non solo spiegare e guidare lo sviluppatore attraverso il framework di test, ma mantenere il processo il più semplice possibile in modo che gli sviluppatori siano incoraggiati a incorporare più test e i nuovi sviluppatori non siano scoraggiati dal dare il proprio contributo.
LDAP: articolo aggiornato unito al capitolo del manuale FreeBSD:
A differenza del capitolo sui test, l'ambito di un articolo o un capitolo aggiornato su LDAP è ben definito.
L'attuale capitolo del Manuale di FreeBSD e l'articolo attuale contengono entrambi molte informazioni utili. Tuttavia, devono essere aggiornati. È stata avviata una nuova revisione dell'articolo, che dovrebbe diventare il nuovo capitolo, ma deve essere completata.
Le attività includono: * Correzione della bozza del capitolo e dell'articolo attuale del manuale. * In preparazione per il programma GSoD2020, abbiamo superato il test iniziale. * Testare ogni sezione del manuale per verificare cosa funziona e cosa deve essere rivisto. * In preparazione per GSoD2020, la configurazione del server è stata testata con miglioramenti identificati. * Altre sezioni rimanenti. * Scrivere nuovi contenuti e rivedere quelli attuali. * È stato avviato l'aggiornamento dei contenuti per la sezione del server. Deve essere completato. * Altre sezioni rimanenti. * Testare tutti i contenuti su sistemi FreeBSD puliti dopo il completamento di una bozza finale. * Questa attività è fondamentale in quanto identifica eventuali lacune.
L'articolo o il capitolo del manuale finale dovrebbe contenere le seguenti sezioni:
(1) Introduzione a LDAP (2) Configurazione del server: (a) Una procedura dettagliata esplicativa di una configurazione di base, ma funzionale, del server OpenLDAP su FreeBSD. (b) Un esempio completo di una configurazione di base, ma funzionale, del server OpenLDAP, ad esempio il risultato di (2a), su FreeBSD.
""Di base, ma funzionale"" include la configurazione del server con password sottoposte ad hashing, connessioni sicure sulla rete e dati utente simulati, ma rappresentativi.
(Facoltativo, da decidere durante il GSoD 2020) La configurazione del server può includere anche la copertura equivalente di 389 Directory Server in FreeBSD. Era presente il supporto sperimentale di FreeBSD in 389 Directory Server, ma il suo stato attuale deve essere confermato.
(3) Configurazione del client: (a) Una procedura dettagliata esplicativa di una configurazione client funzionale su FreeBSD che può connettersi alla connessione del server di esempio fornita in (2). (b) Un esempio completo di configurazione di un client funzionale, ad esempio il risultato di (3a), su FreeBSD.
La sezione di configurazione del client includerà le sottosezioni su quanto segue: * Pluggable Authentication Module (PAM), ad es. pam_ldap, pam_mkhomedir, nss-pam-ldapd * Name Service Switch (NSS), ad es. nss_ldap, nss-pam-ldapd * (Facoltativo: da confermare durante la versione di SSBSD 2020) * (Facoltativo, da decidere durante il GSoD 2020) FreeIPA: è necessario esaminare l'utilizzo e la funzionalità di FreeIPA in FreeBSD. FreeIPA copre più di LDAP, pertanto l'ambito della configurazione di FreeIPA deve essere valutato prima di essere incluso in questo capitolo del manuale.
(4) Considerazioni sulla sicurezza * La versione corrente dell'articolo include una sezione sulle considerazioni sulla sicurezza. Alcuni di questi contenuti potrebbero essere spostati nella sezione pertinente. Tuttavia, dovrebbe essere comunque disponibile una sezione dedicata alle considerazioni sulla sicurezza a scopo di riferimento.
(5) Risoluzione dei problemi * Strategie per la risoluzione dei problemi di configurazione LDAP.
(6) Appendice OpenSSL
Con il capitolo / l'articolo del manuale aggiornato, il lettore può utilizzare due sistemi FreeBSD puliti, configurare un server LDAP e un client LDAP e autenticare il client sul server.
Dopo aver letto il capitolo / l'articolo del manuale aggiornato, il lettore dovrebbe avere le basi necessarie per consultare altra documentazione più specializzata o completa, ad esempio la documentazione di OpenLDAP, le RFC LDAP e creare o perfezionare la configurazione LDAP di FreeBSD in base alle proprie esigenze.