初めてのKubernetesドキュメント翻訳コントリビュート

今回は、先日初めてKubernetesの公式ドキュメント翻訳にコントリビュートした経験について書いてみようと思います。

きっかけは、kubeadmを使って自宅サーバーのKubernetesクラスターを構築している時のことでした。 Kubernetesの公式ドキュメントの日本語翻訳を見ながら作業を進めていたのですが、Containerdのcgroup driverをsystemdに変更するための設定の書き方が、Containerdの最新バージョンのものと異なっていることに気づいたんです。

「あれ?設定ファイルの書き方が違うなぁ」と思って英語の原文を確認してみると、ついこの間Containerdの最新バージョンの設定の書き方がドキュメントに追加されていたことを発見しました。

[plugins.'io.containerd.cri.v1.runtime'.containerd.runtimes.runc]
  ...
  [plugins.'io.containerd.cri.v1.runtime'.containerd.runtimes.runc.options]
    SystemdCgroup = true

英語のドキュメントには最新の情報があるのに、日本語版には反映されていない状況を見て、「日本語のドキュメントにも同じ内容があった方が、日本語で情報を探している人にとって便利だよね」と考えました。

自分と同じようにKubernetesクラスターを構築しようとしている人が、古い設定例で困ることもあるかもしれません。そんな時に最新の情報が日本語でも読めるようになっていれば、きっと役に立つはずです。

といった感じで、「それなら自分で翻訳してみよう!」と思い立ったのがコントリビュートのきっかけでした。

コントリビュートしようと決めたものの、実際にどうやって翻訳作業を進めればいいのかわからない状態だったので、まずはkubernetes/websiteのリポジトリのREADMEを確認することから始めました。

READMEには翻訳のコントリビューションに関する情報へのリンクがあったので、そこから辿って以下のドキュメントを読み込みました:

これらのドキュメントを読むことで、翻訳の進め方やコントリビューションのルールについて理解することができました。

ドキュメントを読んだ後は、実際に他の方が翻訳でコントリビュートした際のプルリクエストを見て参考にしました。

実際のPRを見ることで、以下のようなことが分かりました:

  • コミットメッセージの書き方
  • ファイルの変更範囲
  • レビューでのやり取りの雰囲気

やっぱり実際のやり取りを見るのが一番参考になりますね。

今回の翻訳は、Containerdの設定に関する部分だけだったので、それほど大きな分量ではありませんでした。 とはいえ、技術的な内容を正確に翻訳することと、既存の日本語ドキュメントの文体に合わせることを心がけました。

最終的にレビューのワンラリーを経て、無事にマージすることができました。

https://github.com/kubernetes/website/pull/51940

とても小さい変更ではありましたが、実際にコントリビュートする際の雰囲気を掴むことができました。

これからも積極的にOSSへのコントリビュートを意識してやっていきたいと思います!