docs: Translate all documentation and code comments to English

Author: lyluck-pixiv

README.md

@@ -1,6 +1,6 @@
 # k8s-job-wrapper
 
-`Job` や `CronJob` をテンプレート化して使いやすくする CRD を提供します
+Provides a CRD to make `Job` and `CronJob` easier to use through templating.
 
 > [!WARNING]
 > This repository does not actively accept external contributions.
@@ -16,7 +16,7 @@
 - [direnv](https://github.com/direnv/direnv)
 - [kind](https://github.com/kubernetes-sigs/kind)
 - go version v1.25.0+
-- docker version 28.3.2+.
+- docker version 28.3.2+
 
 ## License
 

hack/README.md

@@ -1,3 +1,3 @@
 # hack
 
-開発ツールやCI/CDの効率化のためのスクリプトを置くディレクトリ
+A directory for scripts to streamline development tools and CI/CD.

hack/chart/README.md

@@ -1,14 +1,16 @@
 # chart
 
-CRD の Helm チャートを `./make.sh ${CHART_VERSION} ${CONTROLLER_IMAGE_REPO} ${CONTROLLER_IMAGE_TAG}` で生成できます
+You can generate the Helm chart for the CRD by running the following command: `./make.sh ${CHART_VERSION} ${CONTROLLER_IMAGE_REPO} ${CONTROLLER_IMAGE_TAG}`.
 
-## 仕組み
+## How it works
 
-[kubebuilder の Helm Plugin](https://book.kubebuilder.io/plugins/available/helm-v1-alpha) を使って Helm チャートを生成し [make.sh](./make.sh) によってチャートのバージョンや controller のイメージなどを置換します
+This project uses the [Kubebuilder Helm Plugin](https://book.kubebuilder.io/plugins/available/helm-v1-alpha) to generate Helm charts.
+The [`./make.sh`](./make.sh) script then replaces values such as the chart version and the controller image.
 
-Chart.yaml については置換ではなく [テンプレート](./Chart.yaml.tmpl) から生成したもので上書きします
-## 成果物
+The `Chart.yaml` file is not modified directly. Instead, it is overwritten with a new file generated from its [template](./Chart.yaml.tmpl).
 
-`./make.sh ${CHART_VERSION} ${CONTROLLER_IMAGE_REPO} ${CONTROLLER_IMAGE_TAG} ${DESTINATION}` と実行した場合は `${DESTINATION}/k8s-job-wrapper-${CHART_VERSION}.tgz` が生成されます
+## Artifacts
 
-DESTINATION を省略した場合はカレントディレクトリに生成されます
+Running the script as `./make.sh ${CHART_VERSION} ${CONTROLLER_IMAGE_REPO} ${CONTROLLER_IMAGE_TAG} ${DESTINATION}` will generate the file `${DESTINATION}/k8s-job-wrapper-${CHART_VERSION}.tgz`.
+
+If you omit the `DESTINATION` argument, the file will be generated in the current directory.

hack/chart/make.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 #
-# Generate Helm chart
+# Generate Helm chart.
 #
 
 set -e

hack/deploy-local.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 #
-# Install CRDs and deploy controller into the kind cluster
+# Install CRDs and deploy controller into the kind cluster.
 #
 
 log() {

hack/docs/README.md

@@ -1,28 +1,33 @@
 # docs
 
-CRD のドキュメントを `./make.sh ${DEST_DIR} ${K8S_VERSION}` で生成できます
+You can generate the documentation for the CRD with the following command: `./make.sh ${DEST_DIR} ${K8S_VERSION}`
 
-## 仕組み
+## How it works
 
-[crd-ref-docs](https://github.com/elastic/crd-ref-docs) を使って [CRDのスキーマ](../../api/v1) から [markdown](docs.md) を生成し [pandoc](https://github.com/jgm/pandoc) を使って html に変換します.
+This process uses [crd-ref-docs](https://github.com/elastic/crd-ref-docs) to generate a [Markdown file](./docs.md) from the [CRD schema](../../api/v1).
+The Markdown is then converted to HTML using [pandoc](https://github.com/jgm/pandoc).
 
-スタイルは公開されている CSS をベースに [カスタマイズ](docs.css) しています
+The visual style is based on a publicly available CSS that has been [customized](./docs.css) for this project.
 
-## ローカルで確認
+## Viewing locally
 
-`$DEST_DIR` に全部入りの `index.html` が作られるので、それをブラウザで開きます.
+A self-contained `index.html` file will be created in the `$DEST_DIR` directory. To view the documentation, simply open this file in your web browser.
 
-## マニフェストの例の更新
+## Updating manifest examples
 
-[examples/results](examples/results) は `config/samples` の内容からコントローラーが生成するリソースです.
-これは手動で書き換える必要があります.
+The resources located in [examples/results](./examples/results) are generated by the controller from the contents of `config/samples`. These example manifests must be updated manually.
 
-``` shell
-# PWD=プロジェクトのルート
-./kind.sh
+To do this, run the following commands from the project's root directory:
+
+```shell
+# PWD=project_root
+make deploy-local
 make sample
 ```
 
-こうしてから `kubectl get job 作られたJOBの名前 -o yaml` などとして取得したものを [examples/results](examples/results) にコミットします
+After the sample resources are created, retrieve the YAML for the generated resource using `kubectl`.
+Then, commit the resulting YAML file to the [examples/results](./examples/results) directory.
+
+For example: `kubectl get job <GENERATED_JOB_NAME> -o yaml`
 
-Examples の部分の記事は [examples/generate.sh](examples/generate.sh) で作っています
+The "Examples" section of the final documentation is generated by the [examples/generate.sh](./examples/generate.sh) script.

hack/docs/docs.css

@@ -1,5 +1,5 @@
 table {
-  border-collapse: collapse; /* 隣接するボーダーを重ねて一本線にする */
+  border-collapse: collapse; /* Collapse adjacent borders into a single line */
   width: 100%;
 }
 
@@ -9,9 +9,9 @@ th, td {
 }
 
 tbody tr {
-  border-bottom: 1px solid #eee8d5; /* solarized lightのベース背景色に近い色 */
+  border-bottom: 1px solid #eee8d5; /* A color similar to the base background color of Solarized Light */
 }
 
 tbody tr:last-child {
-  border-bottom: none; /* 最後の行の下線は不要 */
+  border-bottom: none; /* No underline for the last line */
 }

hack/docs/docs.js

@@ -1,7 +1,7 @@
 //
-// Examples 内部のコードブロックの中の特定の語句を強調する
+// Highlights specific terms within code blocks inside "Examples".
 //
-// NOTE: Examples セクションの配下にしぼってないので別の場所のコードブロックにも適用される
+// NOTE: This is not scoped to the "Examples" section, so it also applies to code blocks elsewhere.
 //
 document.addEventListener('DOMContentLoaded', function() {
   const emphasizeTargets = [

hack/docs/docs.md

@@ -1,10 +1,10 @@
 <!-- Generated by tool. DO NOT EDIT. -->
 # API Reference
-複数の似ている [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) や [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) のマニフェストを, 共通部分と差分のペアの形式で効率的に生成するためのカスタムリソースです.
+This is a custom resource for efficiently generating multiple similar [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) and [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/) manifests in the form of a common part and a set of differences.
 
-- [CRD PodProfile](#podprofile) は Pod の Spec を共通部分として定義できます.
-- [CRD Job](#job) は [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) を生成できます. これは [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) のパラメータと [CRD PodProfile](#podprofile) に対するパッチを含みます.
-- [CRD CronJob](#cronjob) は [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) を生成できます. これは [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) のパラメータと [CRD PodProfile](#podprofile) に対するパッチを含みます.
+- The [PodProfile CRD](#podprofile) allows you to define a Pod's spec as the common part.
+- The [Job CRD](#job) can generate a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/). It includes parameters for the Job and a patch for the [PodProfile CRD](#podprofile).
+- The [CronJob CRD](#cronjob) can generate a [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/). It includes parameters for the CronJob and a patch for the [PodProfile CRD](#podprofile).
 
 ## Examples
 ### Example of CronJob
@@ -625,9 +625,9 @@ _Appears in:_
 
 <script>
 //
-// Examples 内部のコードブロックの中の特定の語句を強調する
+// Highlights specific terms within code blocks inside "Examples"
 //
-// NOTE: Examples セクションの配下にしぼってないので別の場所のコードブロックにも適用される
+// NOTE: This is not scoped to the "Examples" section, so it also applies to code blocks elsewhere
 //
 document.addEventListener('DOMContentLoaded', function() {
   const emphasizeTargets = [

hack/docs/make.sh

@@ -7,8 +7,8 @@ log() {
     echo >&2 "$(basename "$0"): $*"
 }
 
-# 指定した kubernetes バージョンの標準のリソースのドキュメントへのリンクを作るために必要
-# $1: kubernetes バージョン
+# Needed to link to the standard resource documentation for a specific Kubernetes version.
+# $1: kubernetes version
 generate_config() {
     local -r version="$1"
     cat <<EOS
@@ -29,10 +29,10 @@ generate_examples() {
     "${d}/examples/generate.sh"
 }
 
-# CRD からドキュメントを生成する
-# $1: crd-ref-docs の設定ファイル
-# $2: CRD の go ファイルのディレクトリ
-# $3: 出力先ファイル
+# Generate documentation from the CRD.
+# $1: config of crd-ref-docs
+# $2: directory of go files of CRD
+# $3: destination file
 generate_docs() {
     local -r __config="$1"
     local -r __source="$2"
@@ -45,44 +45,43 @@ generate_docs() {
         --output-path "$__output"
 }
 
-# 純粋に CRD から生み出された markdown の1つめの見出しのすぐ下に概要とマニフェスト例をつっこむ
-# $1: markdown ファイル
+# Inject the overview and manifest examples right under the first heading of the markdown purely generated from the CRD.
+# $1: destination markdown file
 insert_summary_and_examples() {
     local -r __out_md="$1"
-    # 生成された markdown であることをコメントする
+    # add a comment to indicate that this is an auto-generated markdown file
     echo '<!-- Generated by tool. DO NOT EDIT. -->'
-    # 1つめの見出し
+    # first heading
     head -n 1 "$__out_md"
-    # 概要(日本語)
+    # overview
     cat <<EOS
-複数の似ている [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) や [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) のマニフェストを, 共通部分と差分のペアの形式で効率的に生成するためのカスタムリソースです.
+This is a custom resource for efficiently generating multiple similar [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) and [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/) manifests in the form of a common part and a set of differences.
 
-- [CRD PodProfile](#podprofile) は Pod の Spec を共通部分として定義できます.
-- [CRD Job](#job) は [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) を生成できます. これは [Job](https://kubernetes.io/ja/docs/concepts/workloads/controllers/job/) のパラメータと [CRD PodProfile](#podprofile) に対するパッチを含みます.
-- [CRD CronJob](#cronjob) は [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) を生成できます. これは [CronJob](https://kubernetes.io/ja/docs/concepts/workloads/controllers/cron-jobs/) のパラメータと [CRD PodProfile](#podprofile) に対するパッチを含みます.
+- The [PodProfile CRD](#podprofile) allows you to define a Pod's spec as the common part.
+- The [Job CRD](#job) can generate a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/). It includes parameters for the Job and a patch for the [PodProfile CRD](#podprofile).
+- The [CronJob CRD](#cronjob) can generate a [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/). It includes parameters for the CronJob and a patch for the [PodProfile CRD](#podprofile).
 EOS
-    # 改行しないとexamplesの見出しが消える
+    # without a line break, the "examples" heading disappears
     echo
-    # マニフェストの例
     generate_examples
-    # 残り
+    # remaining
     tail -n +2 "$__out_md"
 }
 
-# CSS ファイルを生成する
-# $1: 外部 CSS ファイルの URL
-# $2: ローカル CSS ファイル
+# Generate css file.
+# $1: URL of the external css file
+# $2: local css file
 generate_css() {
     local -r __url="$1"
     local -r __file="$2"
     curl -o- -s -L "$__url"
     cat "$__file"
 }
 
-# markdown を html に変換する
-# $1: markdown ファイル
-# $2: CSS ファイル
-# $3: ページのタイトル
+# Convert markdown into html.
+# $1: markdown file
+# $2: css file
+# $3: html title
 generate_html() {
     local -r __out_md="$1"
     local -r __css="$2"
@@ -120,11 +119,11 @@ fi
 
 readonly title="CRD of pixiv.net"
 readonly source_path="${d}/../../api/v1"
-# ベースにする CSS
+# base css
 readonly css_url="http://thomasf.github.io/solarized-css/solarized-light.min.css"
-# 追加の CSS
+# addtional css
 readonly css_file="${d}/docs.css"
-# 追加の JS
+# additional js
 readonly js_file="${d}/docs.js"