update-documentation

ドキュメントの更新

docs.tenzir.com の変更に伴う運用ワークフローを管理します。

ワークフロー

1. tenzir/docs をクローンするか、origin から取得して、.docs/ が存在し最新の状態であることを確認します。
2. .docs/ で、親リポジトリのブランチ名に合わせたトピックブランチを作成するか、チェックアウトします。
3. docs リポジトリ独自のドキュメント作成ガイドラインと規約に従って、.docs/ でコンテンツを更新します。
4. docs リポジトリに関連するドキュメントチェックが用意されている場合は、実行します。
5. .docs/ から tenzir/docs のプルリクエストを作成します。
6. 以下の共通の簡潔なフッターパターンを使って、プルリクエストを相互にリンクします。
   • docs のプルリクエストには、コードのプルリクエストへのリンクと同じ Linear の課題を記載した <sub>...</sub> のフッターブロックを末尾に追加します。例：⚙️ Code PR: tenzir/tenzir#6048<br>🎫 References TNZ-150, TNZ-151。
   • コードのプルリクエストには、📚 Docs PR: tenzir/docs#261 を末尾の <sub>...</sub> フッターに追加するか、既存の内容に追記します。
   • 両方向のプルリクエストリンクには、tenzir/tenzir#6048 や tenzir/docs#261 のように、完全な URL ではなく GitHub の短縮記法を使います。特定のコメントなど、短縮記法では表せない詳細なリンクに限り、完全な URL を使います。
   • 専用の Code PR セクションや Docs PR セクションより、このフッターを優先します。すでにフッターがある場合は、別のフッターを作らず、<br> で区切った行を追加します。
7. 変更内容を要約し、後続作業があれば記載します。

ブランチ

可能な限り、.docs/ のブランチ名をコードのブランチ名に合わせます。 コードの変更が複数のリポジトリにまたがる場合は、コードのブランチ名を基準にして、ブランチ名と相互リンクを決めます。

プルリクエストの相互リンク形式

各プルリクエストの説明の末尾にある簡潔なフッターに、docs とコードの相互リンクを記載します。docs のプルリクエストのフッターでは、関連する docs のプルリクエストが課題を独自に移動させないように、references など、課題を完了扱いにしない語を使って同じ Linear の課題を記載します。複数の課題が同じ関係にある場合は、フッターを簡潔に保つため、1 行に 1 つのマジックワードを使い、その後に課題を列挙します。関係が異なる場合に限り、行を分けます。 docs のプルリクエストの例：

<sub>
⚙️ Code PR: tenzir/tenzir#1234<br>
🎫 References TNZ-150, TNZ-151
</sub>

コードのプルリクエストの例：

<sub>
📚 Docs PR: tenzir/docs#261<br>
✅ Closes TNZ-150, TNZ-151<br>
📎 Related: tenzir/tenzir#5999
</sub>

クロスチェック

docs のプルリクエストを作成する前に、以下を確認します。

1. 変更したページが引き続き適切な Diataxis セクションに属していることを確認します。
2. 近隣のページと「関連項目」へのリンクを確認し、追加の編集が必要か確認します。
3. コードサンプル、パス、UI ラベルが現在の製品の動作と一致していることを確認します。