Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Project FreeBSD
- {i>Technical writer <i}(Penulis teknis):
- Larry
- Nama project:
- Pembaruan pada buku panduan FreeBSD
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Proyek GSoD2020 ini akan terdiri dari dua bab dalam pedoman FreeBSD:
- Pengujian: Bab baru dalam FreeBSD Developers' Handbook
- LDAP: Artikel yang diperbarui digabungkan ke dalam bab di FreeBSD Handbook
Pengujian: Bab baru dalam FreeBSD Developers' Handbook:
CATATAN: Project ini lebih bersifat eksplorasi di awal. Persyaratan dapat berubah selama tahap penulisan.
Tugas persiapan meliputi: * Meninjau dokumentasi dan catatan saat ini tentang framework pengujian developer, praktik, dll. untuk FreeBSD dan BSD lainnya. * Dokumentasi dan catatan FreeBSD saat ini atau yang lebih lama. Misalnya: * TestSuite: https://wiki.freebsd.org/TestSuite * Halaman ""TestingFreeBSD"" lama: https://wiki.freebsd.org/TestingFreeBSD * Dokumentasi dan catatan saat ini dari project terkait. Misalnya: * http://wiki.netbsd.org/tutorials/atf/ * Dokumentasi utama alat yang terlibat. Misalnya: * Framework pengujian Kyua: https://github.com/jmmv/kyua/ * Framework Pengujian Otomatis (ATF): https://github.com/jmmv/atf/ * Menginstal dan mengonfigurasi framework yang relevan untuk mendapatkan pemahaman. * Menggunakan framework pengujian untuk menjalankan pengujian saat ini. * Menulis sejumlah kecil pengujian baru. * (SANGAT penting) Berkonsultasi dengan pembaca (developer dan penguji software) tentang hal yang ingin mereka lihat dalam bab.
Pengaturan dokumentasi secara tepat akan ditentukan. Namun, setelah membaca bab ini, pembaca setidaknya harus dapat melakukan hal berikut:
- Menginstal dan mengonfigurasi framework pengujian untuk tujuan pengujian FreeBSD.
- Menulis pengujian untuk framework pengujian.
- Menjalankan pengujian di framework pengujian.
Hal berikut akan ditekankan jika memungkinkan: * memaksimalkan otomatisasi untuk mengurangi pekerjaan dalam menyiapkan infrastruktur pengujian, menulis pengujian, dan menjalankan pengujian. * menambahkan kasus pengujian setiap kali bug baru diperbaiki. * pengujian regresi otomatis yang komprehensif. * (jika ada) mencakup contoh skenario pengujian standar, seperti pengujian unit, pengujian fungsional, pengujian beban, dan sebagainya.
Jika memungkinkan, tujuannya bukan hanya untuk menjelaskan dan memandu developer melalui framework pengujian, tetapi semoga prosesnya tetap sesederhana mungkin sehingga developer terdorong untuk melakukan lebih banyak pengujian, dan developer baru tidak melenceng untuk berkontribusi.
LDAP: Artikel yang diperbarui digabungkan ke dalam bab di FreeBSD Handbook:
Tidak seperti bab tentang Pengujian, cakupan artikel atau bab yang diperbarui tentang LDAP dipahami dengan baik.
Bab saat ini dalam FreeBSD Handbook dan artikel saat ini berisi banyak informasi yang berguna. Namun, informasi tersebut perlu diperbarui. Revisi baru artikel, yang dimaksudkan untuk menjadi bab baru, telah dimulai, tetapi perlu diselesaikan.
Tugasnya meliputi: * Memeriksa tata bahasa bab panduan saat ini dan artikel saat ini. * Sebagai persiapan untuk GSoD2020, proses awal telah dilakukan. * Menguji setiap bagian dalam buku panduan untuk mengonfirmasi hal yang berhasil dan hal yang perlu direvisi. * Sebagai persiapan untuk GSoD2020, konfigurasi server telah diuji dengan peningkatan yang diidentifikasi. * Bagian lainnya tersisa. * Menulis konten baru dan merevisi konten saat ini. * Konten yang diperbarui telah dimulai untuk bagian server. Tugas ini harus diselesaikan. * Bagian lainnya tersisa. * Menguji semua konten di sistem FreeBSD yang bersih setelah draf akhir selesai. * Tugas ini sangat penting karena mengidentifikasi kesenjangan.
Artikel atau bab buku panduan akhir diharapkan berisi bagian-bagian berikut:
(1) Pengantar LDAP (2) Konfigurasi server: (a) Panduan penjelasan tentang konfigurasi server OpenLDAP dasar tetapi fungsional di FreeBSD. (b) Contoh lengkap konfigurasi server OpenLDAP yang mendasar tetapi berfungsi, misalnya hasil dari (2a), di FreeBSD.
""Dasar tetapi fungsional"" mencakup konfigurasi server dengan sandi yang di-hash, koneksi aman melalui jaringan, dan contoh data pengguna yang disimulasikan tetapi representatif.
(Opsional - Akan diputuskan selama GSoD2020) Konfigurasi server juga dapat mencakup cakupan yang setara dari 389 Directory Server di FreeBSD. Ada dukungan FreeBSD eksperimental di 389 Directory Server, tetapi statusnya saat ini perlu dikonfirmasi.
(3) Konfigurasi klien: (a) Panduan penjelasan tentang konfigurasi klien fungsional di FreeBSD yang dapat terhubung dengan contoh koneksi server yang diberikan di (2). (b) Contoh lengkap konfigurasi klien yang berfungsi, misalnya hasil dari (3a), di FreeBSD.
Bagian konfigurasi klien akan menyertakan subbagian tentang hal berikut: * Pluggable Authentication Module (PAM), misalnya pam_ldap, pam_mkhomedir, nss-pam-ldapd * Name Service Switch (NSS), misalnya nss_ldap, nss-pam-ldapd * (Opsional - Akan diputuskan selama GSoD2020) SSSD - Status SSSD dalam produksi di FreeBSD perlu dikonfirmasi. * (Opsional - Akan diputuskan selama GSoD2020) FreeIPA - Penggunaan dan fungsionalitas FreeIPA di FreeBSD perlu diselidiki. FreeIPA mencakup lebih dari sekadar LDAP sehingga cakupan konfigurasi FreeIPA harus dievaluasi sebelum disertakan dalam bab panduan ini.
(4) Pertimbangan Keamanan * Versi artikel saat ini menyertakan bagian tentang pertimbangan keamanan. Beberapa konten ini mungkin dipindahkan ke bagian yang relevan. Namun, tetap harus ada bagian khusus tentang pertimbangan keamanan untuk tujuan referensi.
(5) Pemecahan masalah * Strategi untuk memecahkan masalah konfigurasi LDAP.
(6) Lampiran OpenSSL
Dengan bab / artikel buku panduan yang diperbarui, pembaca dapat mengambil dua sistem FreeBSD yang bersih, menyiapkan server LDAP dan klien LDAP, dan mengautentikasi klien terhadap server.
Setelah membaca bab / artikel handbook yang diperbarui, pembaca harus memiliki dasar yang diperlukan untuk membaca dokumentasi lain yang lebih khusus atau komprehensif, misalnya dokumentasi OpenLDAP, RFC LDAP, dan membuat atau meningkatkan konfigurasi LDAP FreeBSD untuk memenuhi persyaratan mereka.