Ruby on Rails ガイド

RailsガイドのPull Requestは編集後の生成結果を確認せずに送って良いそうですが、 送る前に確認している方に向けて、Podmanを利用して簡単にローカルでRailsガイドの編集内容を確認する方法のご紹介です。

メインとなるのは、以下の1行のコマンドです。毎回コピペしても良いのですが、長いのでエイリアスを貼ったり、PATHの通った場所にこのコマンドのシェルスクリプトを置いても良いと思います。

podman run -it --rm -v "$PWD":/x -w /x -p 4000:4000 "ruby:$(cat .ruby-version)" bash -c "bundle config set --global path 'vendor/bundle' && bundle install && bundle exec rake assets:precompile && bundle exec jekyll server --host 0.0.0.0"

環境構築

必要になるのはシェルスクリプトを実行できる環境とPodmanのみです。 Podmanのインストールに関してはPodmanの公式インストールガイドをご覧ください。 ちなみにUbuntuなど多くのLinuxディストリビューションでは、aptなどの標準パッケージ管理ツールでPodmanのインストールが可能です。

Podmanを利用して、簡単にローカルでRailsガイドの編集内容を確認する具体的な方法

Podmanがインストールできていれば、以下の手順でRailsガイドの編集と確認が行えます。

1. /guides/source/ja 内の Markdown ファイルを編集する
2. 上述の1行コマンドを実行
3. localhost:4000 から変更結果を確認する

動作不良が起きた等でgemを全て削除したいとき

ちなみに、上述の1行コマンドはvendor/bundle/にgemをインストールします。 Rubyのバージョンが変わって動作不良が起きた際などは、rm -rf vendor/bundle/でgemを全て削除して綺麗な状態にすることが出来ます。

Railsの公式ドキュメントであるRuby on Rails Guidesは、Rails本体の新規リリースに伴って更新されており、そのRails Guidesの日本語版であるRailsガイドもそれらに伴って更新されています。

このTopicでは、このRails本体の新規リリースに伴うRailsガイドの更新に関する情報を取り扱います。

Rails 7.2のリリースに伴い、Railsガイドが更新されました。更新内容は、Railsガイド公式による以下の記事をご参照ください。

• https://note.com/yasslab/n/nb9877f81cee3

Rails 8.0のリリースに伴い、Railsガイドが更新されました。更新内容は、Railsガイド公式による以下の記事をご参照ください。

• https://note.com/yasslab/n/n7b043d76e1e2

Rails 8.0.1のリリースに伴い、Railsガイドが更新されました。更新内容は、Railsガイド公式による以下の記事をご参照ください。

• https://note.com/yasslab/n/n8f0473c0f1cd

日本語版ガイドで「Work in progress」となっている項目は、本家英語版でも「Work in progress」となっているものが多いです。
ですので、「Work in progress」は翻訳途中を表しているわけではありません。

ちなみに、「Work in progress」が付いていても重要な情報を含む項目もありますので、「Work in progress」が付いているからといって読むのを避けるようなことはしない方が良さそうです。