このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソースの組織:
- The FreeBSD Project
- テクニカル ライター:
- Larry
- プロジェクト名:
- FreeBSD ハンドブックの更新
- プロジェクト期間:
- 長期実行（5 か月）
プロジェクトの説明
この GSoD2020 プロジェクトは、FreeBSD ハンドブックの次の 2 つの章で構成されます。
- テスト: FreeBSD デベロッパー ハンドブックの新しい章
- LDAP: 更新された記事を FreeBSD ハンドブックの章に統合
テスト: FreeBSD Developers Handbook の新章:
注: このプロジェクトは、最初はもっと探索的です。要件は作成段階で変更される場合があります。
準備作業には、次のようなものがあります。 * 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 ハンドブックの章に統合しました。
テストに関する章とは異なり、LDAP に関する更新された記事や章の範囲は明確です。
FreeBSD ハンドブックの現在の章と、この記事には多くの有用な情報が記載されています。ただし、更新する必要があります。新しい章となる予定の新しい記事のリビジョンが開始されていますが、完了する必要があります。
タスクには以下が含まれます。 * 現在のハンドブックの章と現在の記事の校正。 * GSoD2020 の準備として、最初のパスが実施されました。* ハンドブックの各セクションをテストして、機能するものと改訂が必要なものを確認します。 * GSoD2020 に備えて、サーバーの構成がテストされ、改善点が特定されました。 * その他のセクションは残りです。 * 新しいコンテンツの作成と現在のコンテンツの改訂。 * サーバー セクションのコンテンツの更新を開始しました。完了する必要があります。 * 残りのセクション。* 最終ドラフト完成後、クリーンな FreeBSD システムですべてのコンテンツをテスト。 * このタスクは、ギャップを見つけるために重要です。
最終的な記事またはハンドブックの章には、次のセクションが含まれていることが期待されます。
（1）LDAP の概要 （2）サーバー構成: （a）FreeBSD での基本的な OpenLDAP サーバー構成の説明とチュートリアル。（b）基本的な機能を持つ OpenLDAP サーバー構成の完全な例（FreeBSD での（2a）の結果など）。
「基本的な機能」には、ハッシュ化されたパスワードを使用したサーバーの構成、ネットワーク経由の安全な接続、代表的なユーザーデータの例が含まれます。
（オプション - GSoD2020 で決定）サーバー構成も、FreeBSD での 389 Directory Server の同等の範囲を含むかもしれません。389 Directory Server では FreeBSD の試験運用版がサポートされていましたが、現在のステータスを確認する必要があります。
（3）クライアント構成: （a）（2）で提供されているサンプル サーバー接続に接続できる FreeBSD の機能的なクライアント構成の説明的なチュートリアル。（b）FreeBSD で機能するクライアント構成の完全な例（（3a）の結果など）。
クライアント構成セクションには、次のサブセクションが含まれます。 * プラグ可能な認証モジュール（PAM）: pam_ldap、pam_mkhomedir、nss-pam-ldapd など * 名前サービス スイッチ（NSS）: nss_ldap、nss-pam-ldapd など * （省略可 - GSoD2020 で決定）SSSD - FreeBSD で本番環境の SSSD のステータスを確認する必要があります。* （オプション - GSoD2020 で決定） FreeIPA - FreeBSD における FreeIPA の使用と機能を検討する必要があります。FreeIPA は LDAP 以外にも対応しているため、このハンドブックの章に含める前に、FreeIPA 構成のスコープを評価する必要があります。
（4）セキュリティに関する考慮事項 * 記事の最新バージョンには、セキュリティに関する考慮事項のセクションが含まれています。一部のコンテンツは、関連するセクションに移動される場合があります。ただし、参考として、セキュリティに関する考慮事項に関する専用のセクションを用意する必要があります。
（5）トラブルシューティング * LDAP 構成のトラブルシューティング戦略。
（6）OpenSSL の付録
更新されたハンドブックの章 / 記事では、2 つのクリーンな FreeBSD システムを使用して、LDAP サーバーおよび LDAP クライアントを設定し、サーバーに対してクライアントを認証できます。
更新されたハンドブックの章 / 記事を読んだ後、読者は、OpenLDAP のドキュメント、LDAP RFC など、より専門的または包括的なドキュメントを参照し、要件を満たすように FreeBSD LDAP 構成を構築または調整するために必要な基礎を身に付けている必要があります。