website/content/ja/docs/contribute/localization.md

7.5 KiB
Raw Blame History

title content_type card
Kubernetesのドキュメントを翻訳する concept
name weight title
contribute 30 Kubernetesのドキュメントを翻訳する

このページでは、Kubernetesドキュメントにおける日本語翻訳の方針について説明します。

ドキュメントを日本語に翻訳するまでの流れ

翻訳を行うための基本的な流れについて説明します。不明点がある場合はKubernetes公式Slack#kubernetes-docs-jaチャンネルにてご連絡ください。

前提知識

翻訳作業は全てGitHubのIssueによって管理されています。翻訳作業を行いたい場合は、Issueの一覧をまず最初にご確認ください。

また、Kubernetes傘下のリポジトリではCLAと呼ばれる同意書に署名されたGitHubユーザーのみがパッチを送ることができます。詳しくは英語のドキュメントや、Qiitaに有志の方が書いてくださった日本語のまとめをご覧ください。

翻訳を始めるまで

翻訳を希望するページのIssueが存在しない場合

  1. こちらのサンプルに従う形でIssueを作成する
  2. 自分自身を翻訳作業に割り当てたい場合は、Issueのメッセージまたはコメントに/assignと書く
  3. 新規ページを翻訳する場合のステップに進む

分からないことがあれば上記Slackチャンネルまでご質問をお願いします。

翻訳を希望するページのIssueが存在した場合

  1. 自分自身を翻訳作業に割り当てるために、Issueのコメントに/assignと書く
  2. 新規ページを翻訳する場合のステップに進む

パッチを送るまで

実際に翻訳作業を行う場合、未翻訳ページの新規作成と既存ページの修正でそれぞれ手順が異なります。

既存ページへの追加修正については、後述のマイルストーンについてに目を通すことをおすすめします。

新規ページを翻訳する場合

  1. kubernetes/websiteリポジトリをフォークする
  2. masterから任意の名前でブランチを作成し、翻訳する箇所を編集する
  3. masterブランチに向けてPull Requestを作成する

既存のページの誤字脱字や古い記述を修正する場合

  1. kubernetes/websiteリポジトリをフォークする
  2. dev-1.17-ja.3(最新のマイルストーンブランチに適宜読み替えること)から任意の名前でブランチを作成し、該当箇所を編集する
  3. dev-1.17-ja.3(最新のマイルストーンブランチに適宜読み替えること)ブランチに向けてPull Requestを作成する
  • masterを追随
    • 更新があり次第、次のMilestoneで追随を行う
  • コントリビューション方法についてはこちらを参照
  • 翻訳スタイルガイドについてはこちらを参照

マイルストーンについて

翻訳作業を集中的に管理するために、日本語を含む複数の言語ではマイルストーンを採用しています。

各マイルストーンでは、

  • 最低要件のコンテンツの追加・更新(項目についてはこちら)
  • バージョンに追従できていない翻訳済みコンテンツの更新

を行い、ドキュメントの全体的なメンテナンスを行っています。

マイルストーンのバージョンはOwner権限を持つメンバーが管理するものとします。

翻訳スタイルガイド

基本方針

  • 本文を、敬体(ですます調)で統一
    • 特に、「〜になります」「〜となります」という表現は「〜です」の方が適切な場合が多いため注意
  • 句読点は「、」と「。」を使用
  • 漢字、ひらがな、カタカナは全角で表記
  • 数字とアルファベットは半角で表記
  • スペースと括弧 () 、コロン : は半角、それ以外の記号類は全角で表記
  • 英単語と日本語の間に半角スペースは不要

頻出単語

英語 日本語
cluster クラスター
orchestrate(動詞) オーケストレーションする
Persistent Volume KubernetesリソースとしてのPersistentVolumeはママ表記、一般的な用語としての場合は、永続ボリューム
Deployment/Deploy KubernetesリソースとしてのDeploymentはママ表記、一般的な用語としてのdeployの場合は、デプロイ
Addon/Add-on アドオン
Quota クォータ
For more information さらなる情報(一時的)
prefix プレフィックス
container コンテナ
directory ディレクトリ
binary バイナリ
controller コントローラー
opeartor オペレーター
Aggregation Layer アグリゲーションレイヤー
Issue Issue (ママ表記)
Pull Request Pull Request (ママ表記)
GitHub GitHub (ママ表記)
registry レジストリ
architecture アーキテクチャ
secure セキュア

備考

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では、英語のソースに対するアップストリームへのコントリビュートや誤りの訂正を歓迎しています。