greenplastic / docs-ja

Couchbase Server Docs Translation project

Couchbase Server公式ドキュメントの翻訳プロジェクトです。ドキュメントはPDFにすると500Page近くのボリュームになります。いち早く公式に日本語ドキュメントを公開できるよう、皆さんのお力をお貸しください。

現在の翻訳状況はpreviewページにて確認できます。

Contribute方法

翻訳に協力

ドキュメントはDITAで記述されています。各トピックが個別のXMLファイル(.dita)です。 翻訳状況の管理と、作業の重複を防ぐために、この翻訳プロジェクトでは各DITAファイルにつきissueを一つずつ作成しています。

例) Translate ja/learn/admin/CLI/CBstats/cbstats-config.dita

issueにはtranslation wantedとhelp wantedのlabelを付けています。未着手のDITAファイルを探すのに利用してください。

jaディレクトリの下にある*.ditaファイルを翻訳し、Pull Requestを送ってください。 WIP (Work In Progress) ブランチをPull Requestする形で運用します。 作業の流れは以下のようになります:

1. couchbaselabs/docs-jaプロジェクトをfork
2. git clone [forkしたプロジェクト]
3. git checkout -b 359
   • issueの番号でブランチを作成します
4. git commit --allow-empty -m 'Work-In-Progress on #359'
5. git push origin 359
   • これで、空コミットが作成されて、Pull Requestできるようになります
6. Pull Requestする この段階でissueにプルリクエストが紐付けられ、作業開始を宣言した状態になります。他の翻訳者の方と作業の重複を防ぐため、翻訳するファイルを決めたら、まずここまで一気にやってしまいましょう
7. 翻訳者は終わったら、最後に push して、プルリクエストの題名プレフィクスを [WIP] から [WFR] にする (Work in Progress -> Waiting for Review) 途中経過を共有したい場合はWIPのままpushしてください 8 レビューが完了したら、Pull Requestをijokarumawakがマージします

上記手順(4) のコミットコメントが重要で、#359 のように「プルリクコミットから参照されたよ」と 自動的に記載されるので、 後から見た人が「ああ、これは着手中なんだな」とわかります。

WIPブランチとPull Requestについては、こちらの記事が分かりやすいです。

ご不明な点はissueのコメントにお願いします。

レビューに協力

previewページをご覧いただき、誤字や誤訳を発見した場合はissueを起票してください:

• 該当箇所がわかるようにコメントをお願いします、ファイル: admin/xxx.dita、もしくはpreviewのURL
• 正誤方式が分かりやすいです、例) 誤:パケットを作成し 正:バケットを作成し

翻訳時の注意事項

• 言語指定: DITA XMLファイル内のmap, topic要素には*xml:lang="ja"*を指定してください。

HTML生成方法

必要なもの

• Java
• DITA Open Toolkit

生成コマンド

./bin/rebuild-docs-out.sh

./out ディレクトリにHTMLドキュメントが生成されます。