Ruby on Rails Guides in Japanese (Railsガイド)
Switch branches/tags
Clone or download
Pull request Compare This branch is even with master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
actioncable Bump license years for 2018 Dec 31, 2017
actionmailer Move the options for deliver_later up near to the example [ci skip] Jan 4, 2018
actionpack Merge pull request #31534 from claudiob/kaspth-approach Jan 9, 2018
actionview Revert unintentional change in 41e3bbd Jan 1, 2018
activejob Consolidate `queue_adapter=` and `interpret_adapter` Jan 5, 2018
activemodel Merge pull request #29018 from willbryant/missing_attributes_after_save Jan 2, 2018
activerecord Use `apply_join_dependency` instead of meaningless named `find_with_a… Jan 10, 2018
activestorage Update error names in docs [ci skip] Jan 10, 2018
activesupport Fix "the the " [ci skip] Jan 10, 2018
ci Fix typos and add a few suggestions Nov 28, 2017
config Move NewRelic config file May 30, 2017
guides Merge pull request #710 from matt-note/patch-1 Sep 20, 2018
railties Clean up railties tests Jan 10, 2018
spec Move spec files & config May 26, 2017
tasks Remove unused variable `gem_version` from `tasks/release.rb` Sep 24, 2017
tools Use frozen string literal in tools/ Aug 13, 2017
yasslab Serve @yasslab logo inside this repository Aug 2, 2018
.codeclimate.yml Keep current Code Climate behavior before upgrade Nov 30, 2017
.gitattributes adds .gitattributes to enable Ruby-awareness Mar 16, 2016
.gitignore Merge branch 'master-20170912210026' into master Sep 12, 2017
.rspec Move spec files & config May 26, 2017
.rubocop.yml Enable `Layout/LeadingCommentSpace` to not allow cosmetic changes in … Dec 14, 2017
.ruby-version Update Ruby2.4.1 to 2.5.1 Mar 30, 2018
.travis.yml Update encrypted API Keys in .travis.yml May 18, 2018
.yardopts Let YARD document the railties gem Sep 10, 2010
CNAME Move railsguides.jp set up files May 30, 2017
CODE_OF_CONDUCT.md Move the CoC text to the Rails website Aug 21, 2015
Gemfile Update Ruby2.4.1 to 2.5.1 Mar 30, 2018
Gemfile.lock bundle update sprockets Aug 2, 2018
MIT-LICENSE Bump license years for 2018 Dec 31, 2017
Procfile Move railsguides.jp set up files May 30, 2017
RAILS_VERSION Preparing for 5.2.0.beta2 release Nov 28, 2017
README.md Update README Sep 16, 2018
RELEASING_RAILS.md Fix grammar issue [ci skip] Oct 31, 2017
Rakefile Merge branch 'master-20170814014556' into master Aug 14, 2017
_config.yml Add jekyll config file May 26, 2017
app.json Move railsguides.jp set up files May 30, 2017
config.ru Add *.githubusercontents.com to CSP Jan 12, 2018
rails.gemspec Use frozen string literal in root files Aug 13, 2017
version.rb Preparing for 5.2.0.beta2 release Nov 28, 2017

README.md

Build Status

日本語訳について

本リポジトリは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のドキュメントに貢献するを参考にしてください。

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を送っていただいて大丈夫です。

翻訳方法の変遷

以下はこれまでの翻訳フロー改善の流れを過去ログとしてまとめています。
基本的に読む必要はありませんが、もし興味あれば適宜ご参照ください ;)

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

Railsガイドを支える継続的翻訳システム - SpeakerDeck

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

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

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

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

原著との差分を更新する方法
  • bin/merge-upstream を実行すると最新版が guides/source 内に取り込まれます。
  • 特に、原著を手元で確認したいとき、原著にPRを送付したいときに便利です。
  • 原著にPRを送るときは、事前にRailsのドキュメントに貢献するに目を通しておくとよいです :)
GTTに最新のドキュメントをアップロードする
GTT上で英語から日本語に翻訳する

運営チーム

本リポジトリは Ruby/Rails の開発を支援する YassLab 株式会社によって制作・運用されております。

📣 【PR】YassLab 社では開発支援も承っております。もし興味あればお気軽にご相談ください ;)

Ruby/Rails の開発支援サービス https://yasslab.jp/ja/agile

Logo of YassLab Inc.

協力者

相談部屋

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

井戸端会議の風景

ライセンス

CC BY-SA International

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

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

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

クレジット