昨年末にRubyコミッターの柴田さんが、るりまの更新作業を一緒にやれる人を募られていて、やりたいです!!とご連絡し、今年の1月に初めてるりまに修正のPRを出しました。
私が修正をしたのはRubyのインストールページのパッケージ管理システムの箇所です。
英語版のサイトの内容と異なる部分があったため、英語版に合わせて日本語版の修正を行いました。
2月も継続して取り組みたかったのですが、忙しさのあまり手がつけられず・・・3月は改めて更新作業もやりたいと思っています!
たくさん助けていただいてPRが出せた
いざるりまの更新作業に取り組むと、やり方がわからないことがたくさんあって、slackのruremaチャンネルでたくさんのフォローをいただいてやっとPRを出すことができました。
まず、修正PRを作成しようとしたところ、権限エラーでpushができない。
何も考えず、リポジトリをcloneしてきてpushしようとしていました(気付け!自分!!)
slackでFBCメンターの伊藤さんをはじめ、複数の方がやり方を共有してくださり、ローカルにForkしてremoteにpushすることができました。
ima1zumiさんのブログにも詳細な手順が書かれています。
PRは作れたものの、今度はローカルで修正した内容をブラウザで確認ができず(確認する前にPRを作ってしまったのは見逃してくださいw)
ima1zumiさんのブログにはBitClustで確認する手順が紹介されていましたが、エラーになってしまいます。
$ bitclust htmlfile ja/documentation/installation/index.md > t.html ja/documentation/installation/index.md:1: met bare method entry in library document; maybe you forgot reopen/redefine level-1 header: "---\n"
再度slackで質問をしたところ、znzさんが www.ruby-lang.org
は BitClust ではなく Jekyll で確認が可能ということを教えてくださりました。
$ bundle exec jekyll serve --watch --future --incremental
BitClustはるりまの更新作業に必要なツールで(私の理解)、その詳細は以下にまとめられています。
JekyllはRubyで開発された静的サイトジェネレータのことです。
初めて聞く名前がたくさん出てきましたが、ドキュメント作成の裏側を垣間見れました。
ローカルでJekyllを使ってブラウザの確認もできたため、正式に修正を送りました。
今回、英語版のインストールページを日本語に直して修正を上げたのですが、誤訳もたくさんしたし適切な日本語を選ぶことが難しいなと痛感しました。
レビューで直していただき、初めてマージされた際はとても嬉しかったです。
まとめ
分からないながらもるりまに修正を送ってみて思ったのは、やってみて分かることがたくさんあった!です。
Ruby初心者で理解が浅い私が更新作業なんてやって大丈夫なのか?と思ったりもしましたが、修正箇所を読み込んで、Rubyのインストール方法がたくさんあることを改めて知ったり、OSSのPRの送り方、どのようにドキュメントが作成されているのかなど、更新作業をきっかけに様々なことを知ることができました。
Rubyのドキュメントには日々助けられているため、内容の更新に対して私も取り組める範囲で今後も関わっていけたらと思っています!