本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- FreeBSD 專案
- 技術撰稿人：
- 小賴
- 專案名稱：
- FreeBSD 手冊更新
- 專案長度：
- 長時間放送 (5 個月)
Project description
這項 GSoD 2020 專案將包含 FreeBSD 手冊中的兩個章節：
- 測試：FreeBSD 開發人員手冊的新章節
- LDAP：將文章合併為 FreeBSD 手冊的章節
測試：FreeBSD 開發人員手冊的新章節：
注意：這項計畫在初期更偏向探索性質。寫作階段的規定可能會有所變動。
準備工作包括： * 查看 FreeBSD 和其他 BSD 的現行開發人員測試架構和實務操作說明文件和筆記。 * 目前或較舊的 FreeBSD 說明文件和附註。例如： * TestSuite：https://wiki.freebsd.org/TestSuite * 舊版「TestingFreeBSD」頁面：https://wiki.freebsd.org/TestingFreeBSD * 相關專案的現行文件和附註。例如： * http://wiki.netbsd.org/tutorials/atf/ * 所用工具的主要文件。例如： * Kyua 測試架構：https://github.com/jmmv/kyua/ * 自動化測試架構 (ATF)：https://github.com/jmmv/atf/ * 安裝及設定相關架構，以便熟悉相關內容。 * 使用測試架構執行目前的測試。 * 編寫少量新測試。* (重要) 與讀者 (軟體開發人員和測試人員) 就章節想看的內容提出異議。
文件的確切架構必須定明確。不過，讀者在閱讀本章後，至少應能執行下列操作：
- 為了測試 FreeBSD，請安裝及設定測試架構。
- 為測試架構編寫測試。
- 在測試架構中執行測試。
我們會盡可能強調以下內容： * 將自動化作業最大化，減少設定測試基礎架構、編寫測試和執行測試的工作。 * 每次修正新錯誤時，新增測試案例。* 全面的自動化回歸測試。* (如適用) 涵蓋標準測試情境的範例，例如單元測試、功能測試、負載測試等。
我們的目標不僅是透過說明和引導，讓開發人員瞭解測試架構，而是盡可能簡化整個程序，鼓勵開發人員加入更多測試，並吸引新開發人員參與貢獻。
LDAP：更新的文章已合併至 FreeBSD 手冊中的章節：
與「Testing」一章不同，更新後的文章或章節中，LDAP 的範圍已清楚說明。
FreeBSD 手冊中的本章和本文都包含許多實用資訊。不過，這些資料需要更新。文章的新修訂版已開始撰寫，但仍需完成，以便成為新章節。
工作包括： * 校對目前的手冊章節和目前的文章。 * 為準備 GSoD 2020，我們已完成初步審查。 * 測試手冊中的每個部分，確認哪些部分有效，哪些部分需要修改。 * 為了準備 2020 年 GSoD，我們已測試伺服器設定，並找出可改善之處。* 其他剩餘部分。* 撰寫新內容及修訂現有內容。 * 已開始更新伺服器部分的內容。必須完成。 * 其他剩餘部分。* 在最終草稿完成後，在乾淨的 FreeBSD 系統上測試所有內容。* 這項工作非常重要，因為它可找出任何落差。
最終文章或手冊章節應包含以下各節：
(1) LDAP (2) 伺服器設定簡介：(a) 逐步說明 FreeBSD 中基本但功能性的 OpenLDAP 伺服器設定。(b) 基本但可正常運作的 OpenLDAP 伺服器設定完整範例，例如在 FreeBSD 上執行 (2a) 的結果。
「基本但可運作」包括使用雜湊密碼設定伺服器、透過網路建立安全連線，以及模擬但代表性的使用者資料。
(選用 - 將於 2020 年 GSoD 期間決定) 伺服器設定也可能包含 FreeBSD 中 389 Directory Server 的等同涵蓋範圍。389 目錄伺服器中有實驗性的 FreeBSD 支援，但需要確認目前的狀態。
(3) 用戶端設定： (a) 說明 FreeBSD 上運作用戶端設定的逐步操作，可連線至 (2) 中提供的範例伺服器連線。(b) 完整的用戶端設定範例，例如在 FreeBSD 上執行 (3a) 的結果。
用戶端設定部分將包含下列子項： * 可插入式驗證模組 (PAM)，例如 pam_ldap、pam_mkhomedir、nss-pam-ldapd * 名稱服務切換器 (NSS)，例如 nss_ldap、nss-pam-ldapd * (選用 - 將於 GSoD2020 期間決定) SSSD - 需要確認 SSSD 在 FreeBSD 中的實際運作狀態。* (選用 - 將於 GSoD 2020 期間決定) FreeIPA - 需要調查 FreeIPA 在 FreeBSD 中的用途和功能。FreeIPA 涵蓋的範圍不只限於 LDAP，因此必須先評估 FreeIPA 設定的範圍，才能將其納入本手冊章節。
(4) 安全性考量 * 本文目前版本包含「安全性考量」一節。部分內容可能會移至相關部分。不過，您還是可以參考專門章節中有關安全性考量的部分。
(5) 疑難排解 * 排解 LDAP 設定問題的策略。
(6) OpenSSL 附錄
在更新的手冊章節 / 文章中，讀者可以使用兩個乾淨的 FreeBSD 系統，設定 LDAP 伺服器和 LDAP 用戶端，並對伺服器進行用戶端驗證。
讀者在閱讀更新版手冊章節 / 文章後，應該具備必要的基礎知識，可參閱其他更專業或全面性的文件 (例如 OpenLDAP 文件、LDAP RFC)，並根據自身需求建構或調整 FreeBSD LDAP 設定。