本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- FreeBSD 项目
- 技术文档工程师：
- Larry
- 项目名称：
- FreeBSD 手册更新
- 项目时长：
- 长时间运行（5 个月）
Project description
本 GSoD2020 项目将包含 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。
- 为测试框架编写测试。
- 在测试框架中运行测试。
我们会尽可能强调以下内容： * 最大限度地实现自动化，以减少设置测试基础架构、编写测试和运行测试的工作量。 * 每修复一个新 bug 时添加测试用例。 * 全面的自动化回归测试。 *（如果适用）涵盖标准测试场景的示例，例如单元测试、功能测试、负载测试等。
我们的目标不仅仅是向开发者说明和引导测试框架，还希望尽可能简化流程，以鼓励开发者进行更多测试，并让新开发者不至于因测试而望而却步。
LDAP：更新了并入 FreeBSD 手册中的文章：
与“测试”章节不同，更新后的 LDAP 文章或章节的范围是众所周知的。
FreeBSD 手册中的当前章节和本文都包含许多实用信息。不过，它们需要更新。我们已开始修改该文章，以便将其作为新章节，但仍需完成。
任务包括： *校对当前手册章节和当前文章。 * 为准备 2020 年 Google 开发者大会，我们已完成初步审核。 * 测试手册中的每个部分，确认哪些内容有效，哪些内容需要修改。 * 为准备 2020 年游戏开发者大会 (GSoD)，我们对服务器配置进行了测试，并确定了改进措施。 * 剩余部分。 * 撰写新内容和修改当前内容。 * 已开始更新服务器部分的内容。需要完成。 * 其他部分仍未完成。 * 在完成最终草稿后，在干净的 FreeBSD 系统上测试所有内容。 * 此任务至关重要，因为它能发现任何不足之处。
最终的文章或手册章节应包含以下部分：
(1) LDAP 简介 (2) 服务器配置： (a) 对 FreeBSD 上基本但实用的 OpenLDAP 服务器配置的说明性演示。 (b) 在 FreeBSD 上，一个基本但功能齐全的 OpenLDAP 服务器配置的完整示例，例如 (2a) 的结果。
“基本但可用”包括使用经过哈希处理的密码配置服务器、通过网络建立安全连接，以及模拟但具有代表性的示例用户数据。
（可选 - 将在 GSoD2020 期间确定）服务器配置可能还包括 FreeBSD 中 389 目录服务器的等效覆盖率。389 Directory Server 支持实验性 FreeBSD，但其目前状态有待确认。
(3) 客户端配置： (a) 对 FreeBSD 上可与 (2) 中提供的示例服务器连接的功能性客户端配置的说明性演示。 (b) FreeBSD 上的功能性客户端配置的完整示例，例如 (3a) 的结果。
客户端配置部分将包含以下子部分： * 可插拔式身份验证模块 (PAM)，例如 pam_ldap、pam_mkhomedir、nss-pam-ldapd * 名称服务切换器 (NSS)，例如 nss_ldap、nss-pam-ldapd *（可选 - 在 GSoD2020 期间确定）SSSD - 需要确认 FreeBSD 中生产环境的 SSSD 状态。 *（可选 - 将在 GSoD2020 期间确定）FreeIPA - 需要调查 FreeIPA 在 FreeBSD 中的使用和功能。FreeIPA 不仅涵盖 LDAP，因此必须先评估 FreeIPA 配置的范围，然后才能将其纳入手册一章。
(4) 安全注意事项 * 本文的当前版本包含一个关于安全注意事项的部分。其中部分内容可能会移至相关部分。不过，仍应有一个专门的部分来介绍安全注意事项，以供参考。
(5) 问题排查 * 排查 LDAP 配置问题的策略。
(6) OpenSSL 附录
通过更新后的手册章节 / 文章，读者可以使用两个干净的 FreeBSD 系统，设置 LDAP 服务器和 LDAP 客户端，并对服务器进行客户端身份验证。
读者在阅读更新后的手册章节 / 文章后，应该具备必要的基础知识，能够阅读其他更专业或更全面的文档（例如 OpenLDAP 文档、LDAP RFC），并构建或优化其 FreeBSD LDAP 配置以满足其要求。