/railsguides.jp

Railsガイドの公開リポジトリです。

Primary LanguageRubyMIT LicenseMIT

Build Status

Ruby on Rails ガイド - 体系的に Rails を学ぼう

『Railsガイド』とは?

『Railsガイド』は Ruby on Rails Guides に基づいた大型リファレンスガイドです。
Railsの各機能を体系的に学び、プロダクト開発の生産性を高めたいときに役立ちます。

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

これから Rails を勉強する方は『Railsチュートリアル』がオススメです。

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

フィードバックについて

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

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

Railsガイド』および『Rails Guides』の品質向上に向けて、皆さまのご協力が得られれば嬉しいです ;)

ブラウザで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 を送る前に生成結果を確認したい場合は下記をご参照ください。
(生成結果を確認せずに Pull Request を送って頂いても大丈夫です! 😆👌)

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

  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. Pull Request (PR) と Continuous Integration (CI)

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

運営チーム

本リポジトリは『創る』『学ぶ』を支援する YassLab 株式会社 によって制作・運用されております。

📣 【PR】YassLab 社では法人・チーム向けサービスを提供しています。興味あればお気軽にご相談ください 🙏 💖

Services for Teams by YassLab Inc.

【PR END】詳細:法人・チーム向けサービス - YassLab 株式会社

YassLab 社以外にも、次の方々が協力してくれました! 🤝✨
様々なご意見・フィードバックありがとうございます! (>人< )✨

協力者

ライセンス

CC BY-SA International

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

ただし『Rails』や『Ruby on Rails』という名称、ならびに Rails のロゴ画像は David Heinemeier Hansson の登録商標であり、本ライセンスの対象ではありません

Ruby on Rails のソースコードMIT ライセンスに基づいて公開されています。

クレジット

YassLab Inc.