Vivliostyle Pubはユーザーファイルの管理に、外部のバージョン管理システム、GitHubを利用しています。ユーザーにとってバージョン管理システムは、以下のようなメリットがあります。
- ファイルの変更履歴が記録できる
- ファイルを以前の状態に戻せる
- 複数ユーザーによる共同編集ができる
残念ながら、上記のうち1、2は現在のバージョンのVivliostyle Pubではサポートされません。これらの機能は各種GitHubクライアントでご利用ください。“Sourcetree” など無料で使えるクライアントが各種あります。たとえば、GitHubの公式クライアントであるGitHub Desktop(無料)での操作は、下記を参照してください。
ここでは上記のうち3、複数ユーザーによる共同編集を、Vivliostyle Pubでおこなう方法について説明します。
(この文書では、個々の作業者を「コミッター」、プロジェクトを統括する者を「管理者」とよびます)
共同編集では、GitHubの「保護されたブランチ」機能を使います。この機能により、本流であるデフォルトブランチで直接編集することが禁止され、作業者は傍流である自分の作業ブランチで編集し、これを管理者のレビューを介してデフォルトブランチへ合流させることが徹底されます。こうした共同作業の結果、間違いの少ない文書を効率的に制作できます。
共同編集は、おおむね以下のような手順ですすめます(次節以降で説明します)。
- コミッターがGitHubのリポジトリでブランチを新規作成する
- コミッターがVivliostyle Pubでそのブランチを選択する
- コミッターがVivliostyle Pubで文書を編集し、保存する
- コミッターがGitHubでプルリクエストを作成する
- 管理者がGitHubでプルリクエストをレビューし、承認とマージをする
上に述べた「保護されたブランチ」機能を自分のリポジトリで使うには、GitHubの有償アカウントを取得するか、無償アカウント(Free)の場合はリポジトリを公開(Public)する必要があります。詳細は下記を参照してください。
ただし、無償アカウントであっても、有資格者からリポジトリに招待されれば共同編集に参加できます。以下を参考にして下さい。