Kubernetesのドキュメントを翻訳する
このページでは、Kubernetesドキュメントにおける日本語翻訳の方針について説明します。
ドキュメントを日本語に翻訳するまでの流れ
翻訳を行うための基本的な流れについて説明します。不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。
前提知識
翻訳作業は全てGitHubのIssueによって管理されています。翻訳作業を行いたい場合は、Issueの一覧をまず最初にご確認ください。
また、Kubernetes傘下のリポジトリではCLAと呼ばれる同意書に署名しないと、Pull Requestをマージすることができません。詳しくは英語のドキュメントや、Qiitaに有志の方が書いてくださった日本語のまとめをご覧ください。
翻訳を始めるまで
翻訳を希望するページのIssueが存在しない場合
- こちらのサンプルに従う形でIssueを作成する
- 自分自身を翻訳作業に割り当てたい場合は、Issueのメッセージまたはコメントに
/assignと書く - 新規ページを翻訳する場合のステップに進む
不明点がある場合はKubernetes公式Slackの#kubernetes-docs-jaチャンネルにてお気軽にご質問ください。
翻訳を希望するページのIssueが存在する場合
- 自分自身を翻訳作業に割り当てるために、Issueのコメントに
/assignと書く - 新規ページを翻訳する場合のステップに進む
Pull Requestを送るまで
未翻訳ページの新規翻訳作業と既存ページの修正作業でそれぞれ手順が異なります。
既存ページへの追加修正については、後述のマイルストーンについてに目を通すことをおすすめします。
新規ページを翻訳する場合の手順
kubernetes/websiteリポジトリをフォークするmasterから任意の名前でブランチを作成するcontent/enのディレクトリから必要なファイルをcontent/jaにコピーし、翻訳するmasterブランチに向けてPull Requestを作成する
既存のページの誤字脱字や古い記述を修正する場合の手順
kubernetes/websiteリポジトリをフォークするdev-1.18-ja.2(最新のマイルストーンブランチに適宜読み替えること)から任意の名前でブランチを作成し、該当箇所を編集するdev-1.18-ja.2(最新のマイルストーンブランチに適宜読み替えること)ブランチに向けてPull Requestを作成する
マイルストーンについて
翻訳作業を集中的に管理するために、日本語を含む複数の言語ではマイルストーンを採用しています。
各マイルストーンでは、
- 最低要件のコンテンツの追加・更新(項目についてはこちらを参照してください)
- バージョンに追従できていない翻訳済みコンテンツの更新
を行い、ドキュメントの全体的なメンテナンスを行っています。
マイルストーンのバージョンはOwner権限を持つメンバーが管理するものとします。
翻訳スタイルガイド
基本方針
- 本文を、敬体（ですます調）で統一
- 特に、「〜になります」「〜となります」という表現は「〜です」の方が適切な場合が多いため注意
- 句読点は「、」と「。」を使用
- 漢字、ひらがな、カタカナは全角で表記
- 数字とアルファベットは半角で表記
- スペースと括弧
()、コロン:は半角、それ以外の記号類は全角で表記 - 英単語と日本語の間に半角スペースは不要
頻出単語
| 英語 | 日本語 |
|---|---|
| Addon/Add-on | アドオン |
| Aggregation Layer | アグリゲーションレイヤー |
| architecture | アーキテクチャ |
| binary | バイナリ |
| cluster | クラスター |
| community | コミュニティ |
| container | コンテナ |
| controller | コントローラー |
| Deployment/Deploy | KubernetesリソースとしてのDeploymentはママ表記、一般的な用語としてのdeployの場合は、デプロイ |
| directory | ディレクトリ |
| For more information | さらなる情報(一時的) |
| GitHub | GitHub (ママ表記) |
| Issue | Issue (ママ表記) |
| operator | オペレーター |
| orchestrate(動詞) | オーケストレーションする |
| Persistent Volume | KubernetesリソースとしてのPersistentVolumeはママ表記、一般的な用語としての場合は、永続ボリューム |
| prefix | プレフィックス |
| Pull Request | Pull Request (ママ表記) |
| Quota | クォータ |
| registry | レジストリ |
| secure | セキュア |
| a set of ~ | ～の集合 |
| stacked | 積層(例: stacked etcd clusterは積層etcdクラスター) |
備考
ServiceやDeploymentなどのKubernetesのAPIオブジェクトや技術仕様的な固有名詞は、無理に日本語訳せずそのまま書いてください。
また、日本語では名詞を複数形にする意味はあまりないので、英語の名詞を利用する場合は原則として単数形で表現してください。
例:
- Kubernetes Service
- Node
- Pod
外部サイトへの参照の記事タイトルは翻訳しましょう。(一時的)
頻出表記（日本語）
| よくある表記 | あるべき形 |
|---|---|
| 〜ので、〜から、〜だから | 〜のため 、〜ため |
| （あいうえお。） | （あいうえお）。 |
| 〇,〇,〇 | 〇、〇、〇（※今回列挙はすべて読点で統一） |
単語末尾に長音記号(「ー」)を付けるかどうか
「サーバー」「ユーザー」など英単語をカタカナに訳すときに、末尾の「ー」を付けるかどうか。
- 「r」「re」「y」などで終わる単語については、原則付ける
- 上の頻出語のように、別途まとめたものは例外とする
参考: https://kubernetes.slack.com/archives/CAG2M83S8/p1554096635015200 辺りのやりとり
cron jobの訳し方に関して
混同を避けるため、cron jobはcronジョブと訳し、CronJobはリソース名としてのままにする。 cron「の」ジョブは、「の」が続く事による解釈の難から基本的にはつけないものとする。
その他基本方針など
- 意訳と直訳で迷った場合は「直訳」で訳す
- 訳で難しい・わからないと感じたらSlackの#kubernetes-docs-jaでみんなに聞く
- できることを挙手制で、できないときは早めに報告
アップストリームのコントリビューター
SIG Docsでは、英語のソースに対するアップストリームへのコントリビュートや誤りの訂正を歓迎しています。