4
4
5
5
このリポジトリには、[ KubernetesのWebサイトとドキュメント] ( https://kubernetes.io/ ) をビルドするために必要な全アセットが格納されています。貢献に興味を持っていただきありがとうございます!
6
6
7
+ - [ ドキュメントに貢献する] ( #contributing-to-the-docs )
8
+ - [ 翻訳された` README.md ` 一覧] ( #localization-readmemds )
9
+
7
10
# リポジトリの使い方
8
11
9
12
Hugo(Extended version)を使用してWebサイトをローカルで実行することも、コンテナランタイムで実行することもできます。コンテナランタイムを使用することを強くお勧めします。これにより、本番Webサイトとのデプロイメントの一貫性が得られます。
@@ -56,6 +59,43 @@ make serve
56
59
57
60
これで、Hugoのサーバーが1313番ポートを使って開始します。お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
58
61
62
+ ## API reference pagesをビルドする
63
+
64
+ ` content/en/docs/reference/kubernetes-api ` に配置されているAPIリファレンスページは< https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs > を使ってSwagger仕様書からビルドされています。
65
+
66
+ 新しいKubernetesリリースのためにリファレンスページをアップデートするには、次の手順を実行します:
67
+
68
+ 1 . ` api-ref-generator ` サブモジュールをプルする:
69
+
70
+ ``` bash
71
+ git submodule update --init --recursive --depth 1
72
+ ```
73
+
74
+ 2 . Swagger仕様書を更新する:
75
+
76
+ ``` bash
77
+ curl ' https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
78
+ ```
79
+
80
+ 3 . 新しいリリースの変更を反映するため、` api-ref-assets/config/ ` で` toc.yaml ` と` fields.yaml ` を適用する。
81
+
82
+ 4 . 次に、ページをビルドする:
83
+
84
+ ``` bash
85
+ make api-reference
86
+ ```
87
+
88
+ コンテナイメージからサイトを作成・サーブする事でローカルで結果をテストすることができます:
89
+
90
+ ``` bash
91
+ make container-image
92
+ make container-serve
93
+ ```
94
+
95
+ APIリファレンスを見るために、ブラウザで< http://localhost:1313/docs/reference/kubernetes-api/ > を開いてください。
96
+
97
+ 5 . 新しいコントラクトのすべての変更が設定ファイル` toc.yaml ` と` fields.yaml ` に反映されたら、新しく生成されたAPIリファレンスページとともにPull Requestを作成します。
98
+
59
99
## トラブルシューティング
60
100
61
101
### 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
@@ -107,7 +147,7 @@ sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
107
147
- [ Slack] ( https://kubernetes.slack.com/messages/kubernetes-docs-ja )
108
148
- [ メーリングリスト] ( https://groups.google.com/forum/#!forum/kubernetes-sig-docs )
109
149
110
- ## ドキュメントに貢献する
150
+ ## ドキュメントに貢献する {#contributing-to-the-docs}
111
151
112
152
GitHubの画面右上にある** Fork** ボタンをクリックすると、お使いのGitHubアカウントに紐付いた本リポジトリのコピーが作成され、このコピーのことを* フォーク* と呼びます。フォークリポジトリの中ではお好きなように変更を加えていただいて構いません。加えた変更をこのリポジトリに追加したい任意のタイミングにて、フォークリポジトリからPull Reqeustを作成してください。
113
153
@@ -124,7 +164,15 @@ Kubernetesのドキュメントへの貢献に関する詳細については以
124
164
* [ ドキュメントのスタイルガイド] ( https://kubernetes.io/docs/contribute/style/style-guide/ )
125
165
* [ Kubernetesドキュメントの翻訳方法] ( https://kubernetes.io/docs/contribute/localization/ )
126
166
127
- ## 翻訳された` README.md ` 一覧
167
+ ### New Contributor Ambassadors
168
+
169
+ コントリビュートする時に何か助けが必要なら、[ 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
+
171
+ | 名前 | Slack | GitHub |
172
+ | -------------------------- | -------------------------- | -------------------------- |
173
+ | Arsh Sharma | @arsh | @RinkiyaKeDad |
174
+
175
+ ## 翻訳された` README.md ` 一覧 {#localization-readmemds}
128
176
129
177
| Language | Language |
130
178
| ---| ---|
0 commit comments