Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- The FreeBSD Project
- Teknik yazar:
- Larry
- Proje adı:
- FreeBSD kılavuzlarında yapılan güncellemeler
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Bu GSoD2020 projesi, FreeBSD kılavuzlarındaki iki bölümden oluşacaktır:
- Test: FreeBSD Geliştirici El Kitabı'nda yeni bölüm
- LDAP: FreeBSD El Kitabı'ndaki bölümde birleştirilen güncellenmiş makale
Test: FreeBSD Geliştirici El Kitabı'nda yeni bölüm:
NOT: Bu proje başlangıçta daha ayrıntılıdır. Şartlar, yazım aşamasında değişebilir.
Hazırlık görevleri şunları içerir: * FreeBSD ve diğer BSD'ler için geliştirici test çerçeveleri, uygulamaları vb. ile ilgili mevcut belgeleri ve notları gözden geçirme. * Güncel veya daha eski FreeBSD dokümanları ve notları. Örneğin: * TestSuite: https://wiki.freebsd.org/TestSuite * Eski ""TestingFreeBSD"" sayfası: https://wiki.freebsd.org/TestingFreeBSD * İlgili projelerdeki güncel dokümanlar ve notlar. Örneğin: * http://wiki.netbsd.org/tutorials/atf/ * İlgili araçların birincil dokümanları. Örneğin: * Kyua test çerçevesi: https://github.com/jmmv/kyua/ * Otomatik Test Çerçevesi (ATF): https://github.com/jmmv/atf/ * Aşina olmak için ilgili çerçeveleri yükleme ve yapılandırma. * Mevcut testleri çalıştırmak için test çerçevelerini kullanma. * Az sayıda yeni test yazmak. * (ÇOK önemli) Okuyuculara (yazılım geliştiricileri ve test kullanıcıları) bu bölümde ne görmek istedikleri konusunda danışmak.
Belgelerin tam düzeni belirlenir. Ancak okuyucu, bölümü okuduktan sonra en azından aşağıdakileri yapabilmelidir:
- FreeBSD'yi test etmek amacıyla test çerçevelerini yükleyip yapılandırın.
- Test çerçevesi için bir test yazın.
- Test çerçevesinde bir test çalıştırın.
Mümkün olduğunda aşağıdakiler vurgulanacaktır: * Test altyapısını oluşturma, test yazma ve test çalıştırma işlerini azaltmak için otomasyonu en üst düzeye çıkarma. * Yeni bir hata düzeltildiğinde test durumları ekleme. * kapsamlı otomatik regresyon testi. * (geçerli olduğu durumlarda) birim testi, işlevsel test, yük testi vb. gibi standart test senaryolarının örneklerini kapsar.
Mümkün olduğunda amaç, geliştiriciye test çerçevesini açıklamak ve bu süreçte yol göstermek değil, aynı zamanda süreci mümkün olduğunca basit tutmaktır. Böylece geliştiriciler daha fazla test eklemeye teşvik edilir ve yeni geliştiriciler katkıda bulunmaktan vazgeçmez.
LDAP: Güncellenen makale, FreeBSD El Kitabı'ndaki bir bölümle birleştirildi:
Test etme bölümünden farklı olarak, LDAP'deki güncellenmiş bir makalenin veya bölümün kapsamı herkes tarafından anlaşılabilir.
FreeBSD El Kitabı'ndaki mevcut bölüm ve mevcut makale, birçok yararlı bilgi içerir. Ancak bu sürümlerin güncellenmesi gerekir. Makalenin yeni bölüm olması amaçlanan yeni bir düzeltmesi başlatıldı ancak tamamlanması gerekiyor.
Görevler şunları içerir: * Mevcut el kitabı bölümünün ve makalenin gözden geçirilmesi. * GSoD2020'ye hazırlanmak için ilk geçiş yapıldı. * Nelerin işe yaradığını ve nelerin düzeltilmesi gerektiğini onaylamak için kılavuzun her bölümünü test etme. * GSoD2020'ye hazırlanırken sunucu yapılandırması, tanımlanan iyileştirmelerle test edilmiştir. * Kalan diğer bölümler. * Yeni içerik yazma ve mevcut içeriği gözden geçirme. * Sunucu bölümü için güncellenmiş içerikler yayınlanmaya başlandı. Bu işlemi tamamlamanız gerekiyor. * Kalan diğer bölümler. * Nihai taslak tamamlandıktan sonra temiz FreeBSD sistemlerindeki tüm içeriği test etme. * Bu görev, boşlukları tespit ettiği için kritik öneme sahiptir.
Nihai makalenin veya el kitabı bölümünün aşağıdaki bölümleri içermesi beklenir:
(1) LDAP'ye giriş (2) Sunucu yapılandırması: (a) FreeBSD'te temel ancak işlevsel bir OpenLDAP sunucu yapılandırmasının açıklayıcı bir adım adım açıklamalı kılavuzu. (b) Temel ancak işlevsel bir OpenLDAP sunucusu yapılandırmasının eksiksiz bir örneği (ör. FreeBSD'deki (2a) sonucu).
"Temel ancak işlevsel"" bölümünde karma şifreler, ağ üzerinden güvenli bağlantılar ve simüle edilmiş ancak temsili örnek kullanıcı verileri içeren sunucu yapılandırması bulunur.
(İsteğe bağlı - GSoD2020 sırasında karar verilecek) Sunucu yapılandırması, FreeBSD'deki 389 Directory Server'ın eşdeğer kapsamını da içerebilir. 389 Directory Server'da deneysel FreeBSD desteği vardı ancak mevcut durumunun doğrulanması gerekiyor.
(3) İstemci yapılandırması: (a) FreeBSD'te (2) bölümünde sağlanan örnek sunucu bağlantısına bağlanabilen işlevsel bir istemci yapılandırmasının açıklayıcı bir adım adım açıklamalı kılavuzu. (b) İşlevsel bir istemci yapılandırmasının eksiksiz örneği (ör. FreeBSD'deki (3a) sonucu).
İstemci yapılandırması bölümünde aşağıdakilerle ilgili alt bölümler yer alır: * Takılabilir Kimlik Doğrulama Modülü (PAM), ör. pam_ldap, pam_mkhomedir, nss-pam-ldapd * Ad Hizmeti Değiştirici (NSS), ör. nss_ldap, nss-pam-ldapd * (İsteğe bağlı - GSoD2020 sırasında karar verilecek) SSSD: FreeBSD'te üretimdeki SSSD'nin durumunun onaylanması gerekir. * (İsteğe bağlı - GSoD2020 sırasında kararlaştırılacaktır) FreeIPA: FreeIPA'nın FreeBSD'deki kullanımı ve işlevselliği araştırılmalıdır. FreeIPA yalnızca LDAP'den daha fazlasını kapsadığından, FreeIPA yapılandırmasının kapsamı bu kılavuz bölümüne dahil edilmeden önce değerlendirilmelidir.
(4) Güvenlikle İlgili Dikkat Edilmesi Gereken Noktalar * Makalenin güncel sürümünde güvenlikle ilgili dikkat edilmesi gereken noktalarla ilgili bir bölüm bulunmaktadır. Bu içeriklerden bazıları ilgili bölüme taşınabilir. Ancak yine de referans olarak kullanılabilecek, güvenlikle ilgili hususları içeren özel bir bölüm bulunmalıdır.
(5) Sorun giderme * LDAP yapılandırmasında sorun giderme stratejileri.
(6) OpenSSL eki
Güncellenmiş el kitabı bölümü / makalesiyle, okuyucu iki temiz FreeBSD sistemini alabilir, bir LDAP sunucusu ile LDAP istemcisi kurabilir ve sunucu üzerinde istemcinin kimliğini doğrulayabilir.
Güncellenen el kitabı bölümünü / makalesini okuyan kullanıcılar, OpenLDAP dokümanları, LDAP RFC'leri gibi daha uzman veya kapsamlı dokümanları incelemek ve FreeBSD LDAP yapılandırmalarını gereksinimlerini karşılayacak şekilde oluşturmak veya hassaslaştırmak için gerekli temele sahip olmalıdır.