Merge pull request #3 from kubernetes/master

merge upstream

Author: npu21

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/docsy"]
+	path = themes/docsy
+	url = https://github.com/google/docsy.git

Makefile

@@ -1,9 +1,16 @@
-DOCKER       = docker
-HUGO_VERSION = $(shell grep ^HUGO_VERSION netlify.toml | tail -n 1 | cut -d '=' -f 2 | tr -d " \"\n")
-DOCKER_IMAGE = kubernetes-hugo
-DOCKER_RUN   = $(DOCKER) run --rm --interactive --tty --volume $(CURDIR):/src
-NODE_BIN     = node_modules/.bin
-NETLIFY_FUNC = $(NODE_BIN)/netlify-lambda
+HUGO_VERSION      = $(shell grep ^HUGO_VERSION netlify.toml | tail -n 1 | cut -d '=' -f 2 | tr -d " \"\n")
+NODE_BIN          = node_modules/.bin
+NETLIFY_FUNC      = $(NODE_BIN)/netlify-lambda
+
+# The CONTAINER_ENGINE variable is used for specifying the container engine. By default 'docker' is used
+# but this can be overridden when calling make, e.g.
+# CONTAINER_ENGINE=podman make container-image
+CONTAINER_ENGINE ?= docker
+CONTAINER_IMAGE   = kubernetes-hugo
+CONTAINER_RUN     = $(CONTAINER_ENGINE) run --rm --interactive --tty --volume $(CURDIR):/src
+
+CCRED=\033[0;31m
+CCEND=\033[0m
 
 .PHONY: all build build-preview help serve
 
@@ -36,25 +43,42 @@ serve: ## Boot the development server.
 	hugo server --buildFuture
 
 docker-image:
-	$(DOCKER) build . \
-		--network=host \
-		--tag $(DOCKER_IMAGE) \
-		--build-arg HUGO_VERSION=$(HUGO_VERSION)
+	@echo -e "$(CCRED)**** The use of docker-image is deprecated. Use container-image instead. ****$(CCEND)"
+	$(MAKE) container-image
 
 docker-build:
-	$(DOCKER_RUN) $(DOCKER_IMAGE) hugo
+	@echo -e "$(CCRED)**** The use of docker-build is deprecated. Use container-build instead. ****$(CCEND)"
+	$(MAKE) container-build
 
 docker-serve:
-	$(DOCKER_RUN) --mount type=tmpfs,destination=/src/resources,tmpfs-mode=0755 -p 1313:1313 $(DOCKER_IMAGE) hugo server --buildFuture --bind 0.0.0.0
+	@echo -e "$(CCRED)**** The use of docker-serve is deprecated. Use container-serve instead. ****$(CCEND)"
+	$(MAKE) container-serve
+
+container-image:
+	$(CONTAINER_ENGINE) build . \
+		--network=host \
+		--tag $(CONTAINER_IMAGE) \
+		--build-arg HUGO_VERSION=$(HUGO_VERSION)
+
+container-build:
+	$(CONTAINER_RUN) $(CONTAINER_IMAGE) hugo
+
+container-serve:
+	$(CONTAINER_RUN) --mount type=tmpfs,destination=/src/resources,tmpfs-mode=0755 -p 1313:1313 $(CONTAINER_IMAGE) hugo server --buildFuture --bind 0.0.0.0
 
 test-examples:
 	scripts/test_examples.sh install
 	scripts/test_examples.sh run
 
 .PHONY: link-checker-setup
 link-checker-image-pull:
-	docker pull wjdp/htmltest
+	$(CONTAINER_ENGINE) pull wjdp/htmltest
+
+docker-internal-linkcheck:
+	@echo -e "$(CCRED)**** The use of docker-internal-linkcheck is deprecated. Use container-internal-linkcheck instead. ****$(CCEND)"
+	$(MAKE) container-internal-linkcheck
+
+container-internal-linkcheck: link-checker-image-pull
+	$(CONTAINER_RUN) $(CONTAINER_IMAGE) hugo --config config.toml,linkcheck-config.toml --buildFuture
+	$(CONTAINER_ENGINE) run --mount type=bind,source=$(CURDIR),target=/test --rm wjdp/htmltest htmltest
 
-docker-internal-linkcheck: link-checker-image-pull
-	$(DOCKER_RUN) $(DOCKER_IMAGE) hugo --config config.toml,linkcheck-config.toml --buildFuture
-	$(DOCKER) run --mount type=bind,source=$(CURDIR),target=/test --rm wjdp/htmltest htmltest

OWNERS_ALIASES

@@ -124,6 +124,7 @@ aliases:
     - girikuncoro
     - irvifa
     - wahyuoi
+    - phanama
   sig-docs-it-owners: # Admins for Italian content
     - fabriziopandini
     - mattiaperi
@@ -133,14 +134,15 @@ aliases:
     - mattiaperi
     - micheleberardi
   sig-docs-ja-owners: # Admins for Japanese content
-    - cstoku
+    # cstoku
     - inductor
     - nasa9084
   sig-docs-ja-reviews: # PR reviews for Japanese content
-    - cstoku
+    - bells17
+    # cstoku
     - inductor
     - makocchi-git
-    - MasayaAoyama
+    # MasayaAoyama
     - nasa9084
     - oke-py
   sig-docs-ko-owners: # Admins for Korean content
@@ -227,6 +229,7 @@ aliases:
     - MaxymVlasov
   sig-docs-uk-reviews: # PR reviews for Ukrainian content
     - anastyakulyk
+    - Arhell
     - butuzov
     - idvoretskyi
     - MaxymVlasov

README-de.md

@@ -15,7 +15,7 @@ Weitere Informationen zum Beitrag zur Kubernetes-Dokumentation finden Sie unter:
 
 * [Mitwirkung beginnen](https://kubernetes.io/docs/contribute/start/)
 * [Ihre Dokumentationsänderungen bereitstellen](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally)
-* [Seitenvorlagen verwenden](http://kubernetes.io/docs/contribute/style/page-templates/)
+* [Seitenvorlagen verwenden](http://kubernetes.io/docs/contribute/style/page-content-types/)
 * [Dokumentationsstil-Handbuch](http://kubernetes.io/docs/contribute/style/style-guide/)
 * [Übersetzung der Kubernetes-Dokumentation](https://kubernetes.io/docs/contribute/localization/)
 

README-es.md

@@ -18,7 +18,7 @@ Para obtener más información sobre cómo contribuir a la documentación de Kub
 
 * [Empezando a contribuir](https://kubernetes.io/docs/contribute/start/)
 * [Visualizando sus cambios en su entorno local](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally)
-* [Utilizando las plantillas de las páginas](http://kubernetes.io/docs/contribute/style/page-templates/)
+* [Utilizando las plantillas de las páginas](http://kubernetes.io/docs/contribute/style/page-content-types/)
 * [Guía de estilo de la documentación](http://kubernetes.io/docs/contribute/style/style-guide/)
 * [Traduciendo la documentación de Kubernetes](https://kubernetes.io/docs/contribute/localization/)
 

README-fr.md

@@ -23,7 +23,7 @@ Pour plus d'informations sur la contribution à la documentation Kubernetes, voi
 
 * [Commencez à contribuer](https://kubernetes.io/docs/contribute/start/)
 * [Apperçu des modifications apportées à votre documentation](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally)
-* [Utilisation des modèles de page](http://kubernetes.io/docs/contribute/style/page-templates/)
+* [Utilisation des modèles de page](https://kubernetes.io/docs/contribute/style/page-content-types/)
 * [Documentation Style Guide](http://kubernetes.io/docs/contribute/style/style-guide/)
 * [Traduction de la documentation Kubernetes](https://kubernetes.io/docs/contribute/localization/)
 

README-ja.md

@@ -3,72 +3,64 @@
 [![Build Status](https://api.travis-ci.org/kubernetes/website.svg?branch=master)](https://travis-ci.org/kubernetes/website)
 [![GitHub release](https://img.shields.io/github/release/kubernetes/website.svg)](https://github.com/kubernetes/website/releases/latest)
 
-ようこそ！このリポジトリには、[KubernetesのWebサイトとドキュメント](https://kubernetes.io/)をビルドするために必要な全アセットが格納されています。貢献に興味を持っていただきありがとうございます！
+このリポジトリには、[KubernetesのWebサイトとドキュメント](https://kubernetes.io/)をビルドするために必要な全アセットが格納されています。貢献に興味を持っていただきありがとうございます！
 
-## ドキュメントに貢献する
-
-GitHubの画面右上にある**Fork**ボタンをクリックすると、お使いのGitHubアカウントに紐付いた本リポジトリのコピーが作成され、このコピーのことを*フォーク*と呼びます。フォークリポジトリの中ではお好きなように変更を加えていただいて構いません。加えた変更をこのリポジトリに追加したい任意のタイミングにて、フォークリポジトリからPull Reqeustを作成してください。
-
-Pull Requestが作成されると、レビュー担当者が責任を持って明確かつ実用的なフィードバックを返します。
-Pull Requestの所有者は作成者であるため、**ご自身で作成したPull Requestを編集し、フィードバックに対応するのはご自身の役目です。**
-また、状況によっては2人以上のレビュアーからフィードバックが返されたり、アサインされていないレビュー担当者からのフィードバックが来ることがある点もご注意ください。
-さらに、特定のケースにおいては、レビュー担当者が[Kubernetes tech reviewer](https://github.com/kubernetes/website/wiki/Tech-reviewers)に対してレビューを依頼することもあります。
-レビュー担当者はタイムリーにフィードバックを提供するために最善を尽くしますが、応答時間は状況に応じて異なる場合があります。
-
-Kubernetesのドキュメントへの貢献に関する詳細については以下のページをご覧ください:
-
-* [貢献のはじめ方](https://kubernetes.io/docs/contribute/start/)
-* [ドキュメントの変更をステージする](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally)
-* [ページテンプレートの使い方](http://kubernetes.io/docs/contribute/style/page-templates/)
-* [ドキュメントのスタイルガイド](http://kubernetes.io/docs/contribute/style/style-guide/)
-* [Kubernetesドキュメントの翻訳方法](https://kubernetes.io/docs/contribute/localization/)
-
-## Dockerを使ってローカル環境でWebサイトを動かす
-
-ローカル環境で本ページを動かすのに推奨される方法は、静的サイトジェネレータの[Hugo](https://gohugo.io)を動かすのに特化した[Docker](https://docker.com)イメージを使うことです。
+## Hugoを使ってローカル環境でWebサイトを動かす
 
-> Windows上で環境を作る場合は[Chocolatey](https://chocolatey.org)を使ってインストール可能な追加のツールが必要になります。 `choco install make`
+Hugoのインストール方法については[Hugoの公式ドキュメント](https://gohugo.io/getting-started/installing/)をご覧ください。このとき、[`netlify.toml`](netlify.toml#L10)ファイルに記述されている`HUGO_VERSION`と同じバージョンをインストールするようにしてください。
 
-> Dockerを使わずに環境を構築したい場合は、[Hugoをローカル環境で動かす](#hugoをローカル環境で動かす)をご覧ください。
-
-既に[Dockerが動いている環境](https://www.docker.com/get-started)であれば、以下のコマンドを使って`kubernetes-hugo`イメージをローカルでビルドします:
+Hugoがインストールできたら、以下のコマンドを使ってWebサイトをローカル上で動かすことができます:
 
 ```bash
-make docker-image
+git clone https://github.com/kubernetes/website.git
+cd website
+git submodule update --init --recursive
+hugo server --buildFuture
 ```
 
-イメージが作成されたら、以下のコマンドを使ってWebサイトをローカル上で動かすことができます:
+これで、Hugoのサーバーが1313番ポートを使って開始します。お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
 
-```bash
-make docker-serve
-```
+## SIG Docsに参加する
 
-お使いのブラウザにて http://localhost:1313 にアクセスすることでWebサイトが開きます。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
+[コミュニティのページ](https://github.com/kubernetes/community/tree/master/sig-docs#meetings)をご覧になることで、SIG Docs Kubernetesコミュニティとの関わり方を学ぶことができます。
 
-## Hugoをローカル環境で動かす
+本プロジェクトのメンテナーには以下の方法で連絡することができます:
 
-Hugoのインストール方法については[Hugoの公式ドキュメント](https://gohugo.io/getting-started/installing/)をご覧ください。このとき、[`netlify.toml`](netlify.toml#L9)ファイルに記述されている`HUGO_VERSION`と同じバージョンをインストールするようにしてください。
+- [Slack](https://kubernetes.slack.com/messages/kubernetes-docs-ja)
+- [メーリングリスト](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
 
-Hugoがインストールできたら、以下のコマンドを使ってWebサイトをローカル上で動かすことができます:
+## ドキュメントに貢献する
 
-```bash
-make serve
-```
+GitHubの画面右上にある**Fork**ボタンをクリックすると、お使いのGitHubアカウントに紐付いた本リポジトリのコピーが作成され、このコピーのことを*フォーク*と呼びます。フォークリポジトリの中ではお好きなように変更を加えていただいて構いません。加えた変更をこのリポジトリに追加したい任意のタイミングにて、フォークリポジトリからPull Reqeustを作成してください。
 
-これで、Hugoのサーバーが1313番ポートを使って開始します。 お使いのブラウザにて http://localhost:1313 にアクセスしてください。リポジトリ内のソースファイルに変更を加えると、HugoがWebサイトの内容を更新してブラウザに反映します。
+Pull Requestが作成されると、レビュー担当者が責任を持って明確かつ実用的なフィードバックを返します。
+Pull Requestの所有者は作成者であるため、**ご自身で作成したPull Requestを編集し、フィードバックに対応するのはご自身の役目です。**
+また、状況によっては2人以上のレビュアーからフィードバックが返されたり、アサインされていないレビュー担当者からのフィードバックが来ることがある点もご注意ください。
+さらに、特定のケースにおいては、レビュー担当者がKubernetesの技術的なレビュアーに対してレビューを依頼することもあります。
+レビュー担当者はタイムリーにフィードバックを提供するために最善を尽くしますが、応答時間は状況に応じて異なる場合があります。
 
-## コミュニティ内での議論、貢献、サポートなどについて
+Kubernetesのドキュメントへの貢献に関する詳細については以下のページをご覧ください:
 
-[コミュニティのページ](http://kubernetes.io/community/)をご覧になることで、Kubernetesコミュニティとの関わり方を学ぶことができます。
+* [Kubernetesのドキュメントへの貢献](https://kubernetes.io/ja/docs/contribute/)
+* [ページコンテントタイプ](https://kubernetes.io/docs/contribute/style/page-content-types/)
+* [ドキュメントのスタイルガイド](https://kubernetes.io/docs/contribute/style/style-guide/)
+* [Kubernetesドキュメントの翻訳方法](https://kubernetes.io/docs/contribute/localization/)
 
-本プロジェクトのメンテナーには以下の方法で連絡することができます:
+## 翻訳された`README.md`一覧
 
-- [Slack](https://kubernetes.slack.com/messages/kubernetes-docs-ja)
-- [メーリングリスト](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
+| Language  | Language |
+|---|---|
+|[中国語](README-zh.md)|[韓国語](README-ko.md)|
+|[フランス語](README-fr.md)|[ポーランド語](README-pl.md)|
+|[ドイツ語](README-de.md)|[ポルトガル語](README-pt.md)|
+|[ヒンディー語](README-hi.md)|[ロシア語](README-ru.md)|
+|[インドネシア語](README-id.md)|[スペイン語](README-es.md)|
+|[イタリア語](README-it.md)|[ウクライナ語](README-uk.md)|
+|[日本語](README-ja.md)|[ベトナム語](README-vi.md)|
 
 ### 行動規範
 
-Kubernetesコミュニティへの参加については、[Kubernetesの行動規範](code-of-conduct.md)によって管理されています。
+Kubernetesコミュニティへの参加については、[CNCFの行動規範](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)によって管理されています。
 
 ## ありがとうございます！
 

README.md

@@ -13,6 +13,7 @@ To run the website locally when you have Hugo installed:
 ```bash
 git clone https://github.com/kubernetes/website.git
 cd website
+git submodule update --init --recursive
 hugo server --buildFuture
 ```
 
@@ -40,7 +41,7 @@ Furthermore, in some cases, one of your reviewers might ask for a technical revi
 For more information about contributing to the Kubernetes documentation, see:
 
 * [Contribute to Kubernetes docs](https://kubernetes.io/docs/contribute/)
-* [Using Page Templates](https://kubernetes.io/docs/contribute/style/page-templates/)
+* [Page Content Types](https://kubernetes.io/docs/contribute/style/page-content-types/)
 * [Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/)
 * [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/)