このマニュアルを改善する¶
マニュアルは Markdown として docs/ ディレクトリに保存され、MkDocs で構築されています。
ローカルプレビュー¶
仮想環境を作成し、ドキュメントの依存関係をインストールします。
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
MkDocs によって出力されたローカル アドレスを開きます。ソース ファイルが変更されると、プレビューが再構築されます。
サイトを検証する¶
プル リクエストを開く前に:
厳密なビルドでは、ナビゲーション エントリの欠落、MkDocs によって検出された無効なリンク、および設定の警告が報告されます。
執筆の原則¶
- 特定のタスクと対象者に向けて書きます。
- 動作がリリース固有である場合は、MRBS バージョンを記載します。
- 網羅的なリストよりもテスト済みの例を優先します。
- 実際の認証情報やプライベートな予約データは決して含めないでください。
- 大きなセクションを複製するのではなく、関連するタスクをリンクします。
- 実用的な場合は、利用可能なすべての翻訳を更新します。
翻訳¶
参考文献は英語です。ドイツ語、フランス語、およびスペイン語のページは、ロケール接尾辞が付いた同じ相対パスを使用します。
翻訳が見つからない場合、サイトは英語に戻ります。翻訳では、ターゲット言語の自然な用語を使用しながら、コード、設定名、警告、リンクを保持する必要があります。
範囲¶
このドキュメント ツリーは MRBS 1.12.2 を対象としています。新しいリリースを説明する変更は、表示されるバージョン範囲を更新するか、そのリリースのドキュメント セットで開発する必要があります。