2
2
3
3
[ ![ Netlify Status] ( https://api.netlify.com/api/v1/badges/be93b718-a6df-402a-b4a4-855ba186c97d/deploy-status )] ( https://app.netlify.com/sites/kubernetes-io-main-staging/deploys ) [ ![ GitHub release] ( https://img.shields.io/github/release/kubernetes/website.svg )] ( https://github.com/kubernetes/website/releases/latest )
4
4
5
- このリポジトリには、[ KubernetesのWebサイトとドキュメント] ( https://kubernetes.io/ ) をビルドするために必要な全アセットが格納されています。貢献に興味を持っていただきありがとうございます !
5
+ このリポジトリには、[ KubernetesのWebサイトとドキュメント] ( https://kubernetes.io/ ) をビルドするために必要な全アセットが格納されています。あなたの貢献をお待ちしています !
6
6
7
7
- [ ドキュメントに貢献する] ( #contributing-to-the-docs )
8
8
- [ 翻訳された` README.md ` 一覧] ( #localization-readmemds )
9
9
10
- # リポジトリの使い方
10
+ ## リポジトリの使い方
11
11
12
- Hugo(Extended version)を使用してWebサイトをローカルで実行することも、コンテナランタイムで実行することもできます。コンテナランタイムを使用することを強くお勧めします。これにより、本番Webサイトとのデプロイメントの一貫性が得られます 。
12
+ Hugo(Extended version)を使用してWebサイトをローカルで実行することも、コンテナランタイムで実行することもできます。コンテナランタイムを使用することを強くお勧めします。これにより、本番Webサイトとのデプロイの一貫性が得られます 。
13
13
14
14
## 前提条件
15
15
16
16
このリポジトリを使用するには、以下をローカルにインストールする必要があります。
17
17
18
18
- [ npm] ( https://www.npmjs.com/ )
19
19
- [ Go] ( https://go.dev/ )
20
- - [ Hugo(Extended version)] ( https://gohugo.io/ )
20
+ - [ Hugo (Extended version)] ( https://gohugo.io/ )
21
21
- [ Docker] ( https://www.docker.com/ ) などのコンテナランタイム
22
22
23
- 開始する前に、依存関係をインストールしてください。リポジトリのクローンを作成し、ディレクトリに移動します。
23
+ > [ !NOTE]
24
+ [ ` netlify.toml ` ] ( netlify.toml#L11 ) の` HUGO_VERSION ` 環境変数で指定されたHugo extended versionをインストールしてください。
24
25
25
- ```
26
+ 始める前に、依存関係をインストールしてください。リポジトリをクローンし、ディレクトリに移動します。
27
+
28
+ ``` bash
26
29
git clone https://github.com/kubernetes/website.git
27
30
cd website
28
31
```
29
32
30
- KubernetesのWebサイトではDocsyというHugoテーマを使用しています 。コンテナでWebサイトを実行する場合でも、以下を実行して、サブモジュールおよびその他の開発依存関係をプルすることを強くお勧めします 。
33
+ KubernetesのWebサイトでは [ DocsyというHugoテーマ ] ( https://github.com/google/docsy#readme ) を使用しています 。コンテナでWebサイトを実行する場合でも、以下を実行して、サブモジュールおよびその他の依存関係を取得することを強くお勧めします 。
31
34
32
- ```
33
- # pull in the Docsy submodule
35
+ ### Windows
36
+
37
+ ``` powershell
38
+ # サブモジュールの依存関係を取得
34
39
git submodule update --init --recursive --depth 1
35
40
```
36
41
42
+ ### Linux / other Unix
43
+
44
+ ``` bash
45
+ # サブモジュールの依存関係を取得
46
+ make module-init
47
+ ```
48
+
37
49
## コンテナを使ってウェブサイトを動かす
38
50
39
51
コンテナ内でサイトを構築するには、以下を実行してコンテナイメージを構築し、実行します。
40
52
41
- ```
42
- make container-image
53
+ ``` bash
54
+ # 環境変数$CONTAINER_ENGINEを設定することで、Docker以外のコンテナランタイムを使用することもできます
43
55
make container-serve
44
56
```
45
57
46
- お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
58
+ エラーが発生した場合はhugoコンテナの計算リソースが不足しています。これを解決するには、使用しているマシン([ MacOS] ( https://docs.docker.com/desktop/settings/mac/ ) と[ Windows] ( https://docs.docker.com/desktop/settings/windows/ ) )でDockerが使用できるCPUとメモリを増やしてください。
59
+
60
+ ブラウザで< http://localhost:1313 > にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
47
61
48
62
## Hugoを使ってローカル環境でWebサイトを動かす
49
63
50
- [ ` netlify.toml ` ] ( netlify.toml#L10 ) ファイルに記述されている ` HUGO_VERSION ` と同じExtended versionのHugoをインストールするようにしてください 。
64
+ ローカルで依存関係をインストールし、サイトを構築してテストするには、次のコマンドを実行します 。
51
65
52
- ローカルでサイトを構築してテストするには、次のコマンドを実行します。
66
+ - For macOS and Linux
67
+ ``` bash
68
+ npm ci
69
+ make serve
70
+ ```
71
+ - For Windows (PowerShell)
72
+ ``` powershell
73
+ npm ci
74
+ hugo.exe server --buildFuture --environment development
75
+ ```
53
76
54
- ``` bash
55
- # install dependencies
56
- npm ci
57
- make serve
58
- ```
59
-
60
- これで、Hugoのサーバーが1313番ポートを使って開始します。お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
77
+ これで、Hugoのサーバーが1313番ポートを使って起動します。使用しているブラウザで< http://localhost:1313 > にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
61
78
62
79
## API reference pagesをビルドする
63
80
64
- ` content/en /docs/reference/kubernetes-api ` に配置されているAPIリファレンスページは< https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs > を使ってSwagger仕様書からビルドされています 。
81
+ ` content/ja /docs/reference/kubernetes-api ` に配置されているAPIリファレンスページは< https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs > を使ってSwagger Specification (OpenAPI Specification)からビルドされています 。
65
82
66
83
新しいKubernetesリリースのためにリファレンスページをアップデートするには、次の手順を実行します:
67
84
68
- 1 . ` api-ref-generator ` サブモジュールをプルする :
85
+ 1 . ` api-ref-generator ` サブモジュールを取得します :
69
86
70
87
``` bash
71
88
git submodule update --init --recursive --depth 1
72
89
```
73
90
74
- 2 . Swagger仕様書を更新する :
91
+ 2 . Swagger Specificationを更新します :
75
92
76
93
``` bash
77
94
curl ' https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
78
95
```
79
96
80
- 3 . 新しいリリースの変更を反映するため、 ` api-ref-assets/config/ ` で ` toc.yaml ` と` fields.yaml ` を適用する 。
97
+ 3 . ` api-ref-assets/config/ ` 内の ` toc.yaml ` と` fields.yaml ` を新しいリリースの変更に合わせます 。
81
98
82
- 4 . 次に、ページをビルドする :
99
+ 4 . 次に、ページをビルドします :
83
100
84
101
``` bash
85
102
make api-reference
86
103
```
87
104
88
- コンテナイメージからサイトを作成・ サーブする事でローカルで結果をテストすることができます:
105
+ コンテナイメージからサイトを作成、 サーブする事でローカルで結果をテストすることができます:
89
106
90
107
``` bash
91
108
make container-image
@@ -94,19 +111,19 @@ make serve
94
111
95
112
APIリファレンスを見るために、ブラウザで< http://localhost:1313/docs/reference/kubernetes-api/ > を開いてください。
96
113
97
- 5 . 新しいコントラクトのすべての変更が設定ファイル` toc.yaml ` と` fields.yaml ` に反映されたら、新しく生成されたAPIリファレンスページとともにPull Requestを作成します。
114
+ 5 . 新しいコントラクトのすべての変更が設定ファイル` toc.yaml ` と` fields.yaml ` に反映されたら、新しく生成されたAPIリファレンスのページとともにPull Requestを作成します。
98
115
99
116
## トラブルシューティング
100
117
101
118
### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
102
119
103
- Hugoは、技術的な理由から2種類のバイナリがリリースされています。現在のウェブサイトは** Hugo Extended** バージョンのみに基づいて運営されています。[ リリースページ] ( https://github.com/gohugoio/hugo/releases ) で名前に「 extended」 が含まれるアーカイブを探します。確認するには、` hugo version ` を実行し、「 extended」 という単語を探します。
120
+ Hugoは、技術的な理由から2種類のバイナリがリリースされています。現在のウェブサイトは** Hugo Extended** バージョンのみに基づいて運営されています。[ リリースページ] ( https://github.com/gohugoio/hugo/releases ) で名前に` extended ` が含まれるアーカイブを探します。確認するには、` hugo version ` を実行し、` extended ` という単語を探します。
104
121
105
122
### macOSにてtoo many open filesというエラーが表示される
106
123
107
124
macOS上で` make serve ` を実行した際に以下のエラーが表示される場合
108
125
109
- ```
126
+ ``` bash
110
127
ERROR 2020/08/01 19:09:18 Error: listen tcp 127.0.0.1:1313: socket: too many open files
111
128
make: *** [serve] Error 1
112
129
```
@@ -115,9 +132,9 @@ OS上で同時に開けるファイルの上限を確認してください。
115
132
116
133
` launchctl limit maxfiles `
117
134
118
- 続いて、以下のコマンドを実行します(https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c より引用)。
135
+ 続いて、以下のコマンドを実行します(< https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c > より引用)。
119
136
120
- ```
137
+ ``` shell
121
138
#! /bin/sh
122
139
123
140
# These are the original gist links, linking to my gists now.
@@ -140,31 +157,40 @@ sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
140
157
141
158
## SIG Docsに参加する
142
159
143
- [ コミュニティのページ] ( https://github.com/kubernetes/community/tree/master/sig-docs#meetings ) をご覧になることで 、SIG Docs Kubernetesコミュニティとの関わり方を学ぶことができます。
160
+ [ コミュニティのページ] ( https://github.com/kubernetes/community/tree/master/sig-docs#meetings ) を確認することで 、SIG Docs Kubernetesコミュニティとの関わり方を学ぶことができます。
144
161
145
162
本プロジェクトのメンテナーには以下の方法で連絡することができます:
146
163
147
- - [ Slack] ( https://kubernetes.slack.com/messages/kubernetes-docs-ja )
164
+ - [ Slack #kubernetes-docs-ja チャンネル ] ( https://kubernetes.slack.com/messages/kubernetes-docs-ja )
148
165
- [ メーリングリスト] ( https://groups.google.com/forum/#!forum/kubernetes-sig-docs )
149
166
150
167
## ドキュメントに貢献する {#contributing-to-the-docs}
151
168
152
- GitHubの画面右上にある** Fork** ボタンをクリックすると、お使いのGitHubアカウントに紐付いた本リポジトリのコピーが作成され、このコピーのことを* フォーク* と呼びます。フォークリポジトリの中ではお好きなように変更を加えていただいて構いません。加えた変更をこのリポジトリに追加したい任意のタイミングにて、フォークリポジトリからPull Reqeustを作成してください。
169
+ GitHubの画面右上にある** Fork** ボタンをクリックすると、GitHubアカウントに紐付いた本リポジトリのコピーが作成されます。このコピーのことを* フォーク* と呼びます。フォークリポジトリの中では好きなように変更を加えることができます。加えた変更をこのリポジトリに反映したい好きなタイミングで、フォークリポジトリからPull Reqeustを作成してください。
170
+
171
+ Pull Requestが作成されると、レビュー担当者が責任を持って明確かつ実用的なフィードバックを返します。Pull Requestの所有者は作成者であるため、** 自分自身で作成したPull Requestを編集し、フィードバックに対応するのはあなたの責任です。**
153
172
154
- Pull Requestが作成されると、レビュー担当者が責任を持って明確かつ実用的なフィードバックを返します。Pull Requestの所有者は作成者であるため、 ** ご自身で作成したPull Requestを編集し、フィードバックに対応するのはご自身の役目です。 **
173
+ また、状況によっては2人以上のレビュアーからフィードバックが返されたり、アサインされていないレビュアーからのフィードバックが来ることがある点も留意してください。
155
174
156
- また、状況によっては2人以上のレビュアーからフィードバックが返されたり、アサインされていないレビュー担当者からのフィードバックが来ることがある点もご注意ください 。
175
+ さらに、特定のケースにおいては、レビュアーがKubernetesの技術的なレビュアーに対してレビューを依頼することもあります。レビュー担当者はタイムリーにフィードバックを提供するために最善を尽くしますが、応答時間は状況に応じて異なる場合があります 。
157
176
158
- さらに、特定のケースにおいては、レビュー担当者がKubernetesの技術的なレビュアーに対してレビューを依頼することもあります。レビュー担当者はタイムリーにフィードバックを提供するために最善を尽くしますが、応答時間は状況に応じて異なる場合があります。
177
+ > [ !NOTE]
178
+ ローカライゼーションにおいては、技術的なレビューを行うことはありません。技術的なレビューは英語版のドキュメントに対してのみ行われます。
159
179
160
- Kubernetesのドキュメントへの貢献に関する詳細については以下のページをご覧ください:
180
+ Kubernetesのドキュメントへの貢献に関する詳細については以下のページを確認してください:
181
+
182
+ > [ !NOTE]
183
+ 日本語のローカライゼーションを行う際は、[ Kubernetesのドキュメントを翻訳する] ( https://kubernetes.io/ja/docs/contribute/localization/ ) が参照すべきガイドとなります。
161
184
162
185
* [ Kubernetesのドキュメントへの貢献] ( https://kubernetes.io/ja/docs/contribute/ )
163
186
* [ ページコンテントタイプ] ( https://kubernetes.io/docs/contribute/style/page-content-types/ )
164
187
* [ ドキュメントのスタイルガイド] ( https://kubernetes.io/docs/contribute/style/style-guide/ )
165
188
* [ Kubernetesドキュメントの翻訳方法] ( https://kubernetes.io/docs/contribute/localization/ )
166
189
167
- ### New Contributor Ambassadors
190
+ ### 新たなコントリビューターのためのアンバサダー
191
+
192
+ > [ !NOTE]
193
+ 日本語のローカライゼーションに関する質問は、[ Slack #kubernetes-docs-ja チャンネル] ( https://kubernetes.slack.com/messages/kubernetes-docs-ja ) にてお気軽にお尋ねください。
168
194
169
195
コントリビュートする時に何か助けが必要なら、[ New Contributor Ambassadors] ( https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador ) に聞いてみると良いでしょう。彼らはSIG Docsのapproverで、最初の数回のPull Requestを通して新しいコントリビューターを指導し助けることを責務としています。New Contributors Ambassadorsにコンタクトするには、[ Kubernetes Slack] ( https://slack.k8s.io ) が最適な場所です。現在のSIG DocsのNew Contributor Ambassadorは次の通りです:
170
196
@@ -186,7 +212,7 @@ Kubernetesのドキュメントへの貢献に関する詳細については以
186
212
187
213
### 行動規範
188
214
189
- Kubernetesコミュニティへの参加については、[ CNCFの行動規範] ( https://github.com/cncf/foundation/blob/master /code-of-conduct.md ) によって管理されています。
215
+ Kubernetesコミュニティへの参加については、[ CNCFの行動規範] ( https://github.com/cncf/foundation/blob/main /code-of-conduct-languages/ja .md ) によって管理されています。
190
216
191
217
## ありがとうございます!
192
218
0 commit comments