kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[ja] Improvement of `Localizing Kubernetes documentation` for Japanese (#45037) 

* feat: add some words

* feat: add docs regarding node(s)

* feat: add custom ID

* update: add some words in scripts/ja/verify-spelling.sh

* update: add "インタフェース" in scripts/ja/verify-spelling.sh

* fix: use half-wide parens

* update: L66

* update: terminology

* update: long-vowel

* update: other-notation

* update: minor fixes

* update: basci policy

* update: #long-bowel

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: #other-notation}

* update: nits and ready for review

* revert: scripts/ja/verify-spelling.sh

* nits

* nits

* update: L103

Co-authored-by: nasa9084 <nasa9084@users.noreply.github.com>

* update: L67

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: L71

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: L81

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: L90

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: L94

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

* update: L124

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>

---------

Co-authored-by: inukai <82919057+t-inu@users.noreply.github.com>
Co-authored-by: nasa9084 <nasa9084@users.noreply.github.com>
pull/45769/head
Junya Okabe 2024-04-04 11:37:29 +09:00 committed by GitHub
parent d1232f1d58
commit f5384f7c4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 50 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
content/ja/docs/contribute/localization.md
View File

@ -14,19 +14,19 @@ card:
<!-- body -->
## ドキュメントを日本語に翻訳するまでの流れ
## ドキュメントを日本語に翻訳するまでの流れ {#translate-flow}
翻訳を行うための基本的な流れについて説明します。不明点がある場合は[Kubernetes公式Slack](http://slack.kubernetes.io/)の`#kubernetes-docs-ja`チャンネルにてお気軽にご質問ください。
### 前提知識
### 前提知識 {#prerequisite}
翻訳作業は全て[GitHubのIssue](https://github.com/kubernetes/website/issues?q=is%3Aissue+is%3Aopen+label%3Alanguage%2Fja)によって管理されています。翻訳作業を行いたい場合は、Issueの一覧をまず最初にご確認ください。
また、Kubernetes傘下のリポジトリでは`CLA`と呼ばれる同意書に署名しないと、Pull Requestをマージすることができません。詳しくは[英語のドキュメント](https://github.com/kubernetes/community/blob/master/CLA.md)や、[Qiitaに有志の方が書いてくださった日本語のまとめ](https://qiita.com/jlandowner/items/d14d9bc8797a62b65e67)をご覧ください。
### 翻訳を始めるまで
### 翻訳を始めるまで {#start-translation}
#### 翻訳を希望するページのIssueが存在しない場合
#### 翻訳を希望するページのIssueが存在しない場合 {#no-issue}
1. [こちらのサンプル](https://github.com/kubernetes/website/issues/22340)に従う形でIssueを作成する
2. 自分自身を翻訳作業に割り当てたい場合は、Issueのメッセージまたはコメントに`/assign`と書く
@ -34,12 +34,12 @@ card:
**不明点がある場合は[Kubernetes公式Slack](http://slack.kubernetes.io/)の`#kubernetes-docs-ja`チャンネルにてお気軽にご質問ください。**
#### 翻訳を希望するページのIssueが存在する場合
#### 翻訳を希望するページのIssueが存在する場合 {#exist-issue}
1. 自分自身を翻訳作業に割り当てるために、Issueのコメントに`/assign`と書く
2. [新規ページを翻訳する場合](#translate-new-page)のステップに進む
### Pull Requestを送るまで
### Pull Requestを送るまで {#create-pull-request}
#### 新規ページを翻訳する場合の手順 {#translate-new-page}
@ -48,95 +48,82 @@ card:
3. `content/en`のディレクトリから必要なファイルを`content/ja`にコピーし、翻訳する
4. `main`ブランチに向けてPull Requestを作成する
#### 既存のページの誤字脱字や古い記述を修正する場合の手順
#### 既存のページの誤字脱字や古い記述を修正する場合の手順 {#fix-existing-page}
1. `kubernetes/website`リポジトリをフォークする
2. `main`から任意の名前でブランチを作成する
3. `content/ja`のディレクトリから必要なファイルを編集する
4. `main`ブランチに向けてPull Requestを作成する
## 翻訳スタイルガイド
## 翻訳スタイルガイド {#style-guide}
### 基本方針
### 基本方針 {#basic-policy}
- 本文を、敬体（ですます調）で統一
- 本文を、敬体(ですます調)で統一
- 特に、「〜になります」「〜となります」という表現は「〜です」の方が適切な場合が多いため注意
- 句読点は「、」と「。」を使用
- 漢字、ひらがな、カタカナは全角で表記
- 数字とアルファベットは半角で表記
- スペースと括弧 `()` 、コロン `:` は半角、それ以外の記号類は全角で表記
- 記号類は感嘆符「！」と疑問符「？」のみ全角、それ以外は半角で表記
- 英単語と日本語の間に半角スペースは不要
- 日本語文では、文章の途中で改行を行わない。句点「。」で改行する
- メタデータの`reviewer`の項目は削除する
- すでに日本語訳が存在するページにリンクを張る場合は、`/ja/`を含めたURLを使用する
- 例: `/path/to/page/`ではなく、`/ja/path/to/page/`を使用する
### 頻出単語
### 用語の表記 {#terminology}
英語 | 日本語
--------- | ---------
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クラスター)
Kubernetesのリソース名や技術用語などは、原則としてそのままの表記を使用します。
例えば、PodやService、Deploymentなどは翻訳せずにそのまま表記してください。
### 備考
ただし、ノード(Node)に関しては明確にKubernetesとしてのNodeリソース(例: `kind: Node`や`kubectl get nodes`)を指していないのであれば、「ノード」と表記してください。
ServiceやDeploymentなどのKubernetesのAPIオブジェクトや技術仕様的な固有名詞は、無理に日本語訳せずそのまま書いてください。
またこれらの単語は、複数形ではなく単数形を用います。
例えば、原文に"pods"と表記されている場合でも、日本語訳では"Pod"と表記してください。
また、日本語では名詞を複数形にする意味はあまりないので、英語の名詞を利用する場合は原則として単数形で表現してください。
例:
- Kubernetes Service
- Node
- Pod
外部サイトへの参照の記事タイトルは翻訳しましょう。(一時的)
### 頻出表記（日本語）
### 頻出表記(日本語) {#frequent-phrases}
よくある表記 | あるべき形
--------- | ---------
〜ので、〜から、〜だから| 〜のため 、〜ため
（あいうえお。）| （あいうえお）。
〇,〇,〇|〇、〇、〇（※今回列挙はすべて読点で統一）
(あいうえお。)| (あいうえお)。
〇,〇,〇|〇、〇、〇(※列挙はすべて読点で統一)
### 単語末尾に長音記号(「ー」)を付けるかどうか
### 長音の有無 {#long-vowel}
「サーバー」「ユーザー」など英単語をカタカナに訳すときに、末尾の「ー」を付けるかどうか。
カタカナ語に長音を付与するかどうかは、以下の原則に従ってください。
- 「r」「re」「y」などで終わる単語については、原則付ける
- 上の頻出語のように、別途まとめたものは例外とする
- -er、-or、-ar、-cy、-gyで終わる単語は長音を付与する
- 例: 「クラスター」「セレクター」「サイドカー」「ポリシー」「トポロジー」
- -ear、-eer、-re、-ty、-dy、-ryで終わる単語は長音を付与しない
- 例: 「クリア」「エンジニア」「アーキテクチャ」「セキュリティ」「スタディ」「ディレクトリ」
参考: https://kubernetes.slack.com/archives/CAG2M83S8/p1554096635015200 辺りのやりとり
ただし、「コンテナ」は例外的に長音を付与しないこととします。
### cron jobの訳し方に関して
この原則を作成するにあたって、[mozilla-japan/translation Editorial Guideline#カタカナ語の表記](https://github.com/mozilla-japan/translation/wiki/Editorial-Guideline#カタカナ語の表記)を参考にしました。
混同を避けるため、cron jobはcronジョブと訳し、CronJobはリソース名としてのままにする。
cron「の」ジョブは、「の」が続く事による解釈の難から基本的にはつけないものとする。
### その他の表記 {#other-notation}
### その他基本方針など
その他の表記については、以下の表を参考にしてください。
英語 | 日本語
--------- | ---------
interface | インターフェース
proxy | プロキシ
quota|クォータ
stacked | 積層
### cron jobの訳し方に関して {#cron-job}
混同を避けるため、cron jobはcronジョブと訳し、CronJobはリソース名としてそのまま表記します。
cron「の」ジョブは、「の」が続く事による解釈の難から基本的にはつけないものとします。
### その他基本方針など {#other-basic-policy}
- 意訳と直訳で迷った場合は「直訳」で訳す
- 訳で難しい・わからないと感じたらSlackの#kubernetes-docs-jaでみんなに聞く
- 訳で難しい・わからないと感じたらSlackの`#kubernetes-docs-ja`で相談する
- できることを挙手制で、できないときは早めに報告
## アップストリームのコントリビューター
## アップストリームのコントリビューター {#upstream-contributor}
SIG Docsでは、英語のソースに対する[アップストリームへのコントリビュートや誤りの訂正](/docs/contribute/intermediate#localize-content)を歓迎しています。