main
)は、公開中のドキュメントのビルドに使用されるコンテンツを表します。その他のブランチは、それらをデプロイブランチにマージしない限り、公開中のドキュメントから独立しています。
ブランチを使うと、公開前に変更を加え、レビューを受け、新しいアプローチを試すための、ドキュメントの別インスタンスを作成できます。チームはブランチ上で作業し、ドキュメントの異なる部分を同時に更新できます。変更を公開するまで、公開サイトのユーザーが見る内容に影響は出ません。
公開サイトの安定性を保ち、レビューのワークフローを可能にするため、ドキュメントの更新は常にブランチで行うことを推奨します。
- ブランチ名は明確にし、チームメンバーが作業内容を理解できるようにしましょう。
- リポジトリを整理するため、マージ後はブランチを削除しましょう。
- ほかの作業に影響し得る大きな変更に取り組む際は、事前にチームへ共有しましょう。
ブランチの作成
- エディタのツールバーでブランチ名を選択します(通常はデフォルトで「main」)。
- New Branch を選択します。
update-getting-started
やfix-api-examples
のような、ブランチの説明的な名前を入力します。- Create Branch を選択します。
ブランチで変更を保存する
ブランチの切り替え
- エディタのツールバーでブランチ名を選択します。
- ドロップダウンメニューから切り替えるブランチを選択します。
ブランチを切り替えると未保存の変更は失われます。切り替える前に、作業内容を保存または公開してください。