garin/railsguides.jp

Ruby on Rails Guides in Japanese (Railsガイド)

日本語訳について

本リポジトリはRuby on Rails Guidesを日本語に訳したものです。
Railsガイドでは、Railsの各機能の仕組みや最新の機能、リリース情報などがまとまっています。

Ruby on Rails ガイド
https://railsguides.jp/

これからRailsを勉強する方は「Railsチュートリアル」がオススメです。
Railsガイドと同様に、RailsチュートリアルもWeb版は無料で読めます :)

Ruby on Rails チュートリアル：実例を使ってRailsを学ぼう
https://railstutorial.jp/

フィードバックについて

本ガイドを読んで、誤字・脱字・誤訳などを見かけましたら、本リポジトリの Issue にてお気軽に報告して頂けると幸いです。「直接Pull Request を送りたい!」という場合には、下記の「Railsガイドの生成方法」を参照してください。

もし原著の間違いを見つけましたら、本ガイドのRailsのドキュメントに貢献する を参考にしてください。

本ガイドの品質向上に向けて、皆さまのご協力が得られれば幸いです。よろしくお願い致します。

ブラウザでRailsガイドの修正を提案する

多分これが一番簡単だと思います。

1. ブラウザ上で guides/source/ja を開く
2. 直したいファイルを開く (例: upgrading_ruby_on_rails.md)
3. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
4. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
5. 修正内容を確認し、問題なければ Create pull request をクリックする

以上で完了です。提案されたRailsガイドの修正はコミッターによって再確認され、問題なければ提案された内容が反映されます。もし問題があってもコミッター側で気付いて修正することができるので、まずはお気軽に提案してみてください ;)

Railsガイドの生成方法

本リポジトリにPull Requestを送付したい方は、下記を参照してください。

1. 既存のHTMLファイルをローカルで生成および確認(Jekyll)

(rubyのバージョンは.ruby_versionに記載があります。)

1. $ bundle install
2. $ bundle exec rake assets:precompile
3. $ bundle exec jekyll server
4. localhost:4000 から既存のHTMLファイルを確認する

2. 編集したHTMLをローカルで生成および確認 (Jekyll)

1. /guides/source/ja 内の Markdown ファイルを編集する
2. $ bundle exec rake assets:precompile
3. $ bundle exec jekyll server
4. localhost:4000 から変更結果を確認する
5. (問題なければ) PRを送付する

3. CI と Heroku

• PRが送られると、railsguides.jpのTravis CI が走ります。
• CIが通らなかった場合は、該当箇所を修正してください。
• マージされない限り本番環境 (Heroku) には反映されないので、気軽にPRを送っていただいて大丈夫です。

翻訳方法の変遷

以下は原著へのフィードバックや、翻訳に関するより詳細な情報です。必要に応じてご参照ください ;)

継続的翻訳システムについて (現在移行中)

本リポジトリの仕組みについては、上記のスライドで詳しく解説されています。

翻訳の流れ (継続的翻訳システム移行前の構成)

参考: [翻訳]Ruby on Rails 4.1リリース前にアップグレードガイドを先行翻訳した & 同じ翻訳を2回しないで済むようにした

なお、移行後は次のようなフローで更新していく予定です。

原著との差分を更新する方法

• bin/merge-upstream を実行すると最新版が guides/source 内に取り込まれます。
• 特に、原著を手元で確認したいとき、原著にPRを送付したいときに便利です。
• 原著にPRを送るときは、事前にRailsのドキュメントに貢献するに目を通しておくとよいです :)

GTTに最新のドキュメントをアップロードする

• Google Translator Toolkit: https://translate.google.com/toolkit/
• Markdownは対応してないので、必要に応じてファイル名を hogehoge.md.txt などに変更する。
• NOTE: 必ずRailsガイド用の翻訳メモリに結びつけること。(shared TM は使わない)
  • cf. 翻訳メモリの使用 - Translate ヘルプ - Google Help

GTT上で英語から日本語に翻訳する

• 詳細: Google Translator Toolkitと翻訳メモリ(ノーカット版) : RubyWorld Conference 2013より
• GTTの使用方法や文体などに関してはこちらを参考にしてください。
• NOTE: 行頭にある(TIP|IMPORTANT|CAUTION|WARNING|NOTE|INFO|TODO)[.:]は、guides:generate:html で使われるタグです。 これらのタグは訳さないでください。

運営チーム

本リポジトリは、Ruby/Railsの開発を支援する YassLab 社によってメンテナンスされております。

公式ドキュメントを支えるチームで、御社のプロジェクトを支援します。お気軽にお問い合わせください。

Ruby/Rails の開発支援サービス - YassLab 株式会社
https://yasslab.jp/ja/agile

協力者

• @hachi8833 (共同発起人)
• @yasulab (共同発起人)
• @yui-knk (コミッター)
• @riseshia (コミッター)
• @willnet (コミッター)
• 他，Issues や Pull Request を送ってくださった多くの方々。

相談部屋

idobata.io の yasslab/railsguides.jp 部屋にて、Rails ガイドに関する情報交換しています。
覗いてみるだけの方も歓迎なので、是非お気軽に立ち寄ってみてください :D

ライセンス

本ガイドはクリエイティブ・コモンズ 表示-継承 4.0 国際 (CC BY-SA 4.0) ライセンスに基づいて公開されています。

「Rails」および「Ruby on Rails」という名称、そして Rails のロゴは、David Heinemeier Hansson による登録商標で、すべての権利を有しています。

Ruby on RailsはMITライセンスに基づいて公開されています。

クレジット

• 原著: http://guides.rubyonrails.org/credits.html
• 本書: @hachi8833, @yasulab