Skip to content

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

License

Notifications You must be signed in to change notification settings

fkmy/railsguides.jp

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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ガイドを読んで誤字・脱字・誤訳などを見かけましたら、下記の『ブラウザでRailsガイドの修正を提案する』に沿って Pull Request (プルリク) を送っていただけると嬉しいです 😌

もし原著 (英語版) の間違いを見つけたら プルリクチャンス です! Railsガイドの『Railsのドキュメントに貢献する』を参考に :octocat: 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 の GitHub Actions が走ります。
  • CI が通らなかった場合は、該当箇所を修正してください。(bundle exec rake testでローカル環境でも確認できます)
  • マージされない限り本番環境には反映されないので、PR は気軽に送ってください! 😆👌

運営チーム

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

📣 【PR】YassLab 社ではRailsガイド協賛プランや、Railsチュートリアル研修支援などにも対応しています。まずは無料の導入相談からぜひ! 🙏 💖


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

協力者

支援・協賛

Railsガイドでは、ドキュメントを通してRuby/Railsコミュニティを一緒に支援してくださる企業を募集しております。詳細は「協賛プラン」のページよりご確認ください。

協賛プラン: https://railsguides.jp/sponsors

協賛プラン バナー画像


ライセンス

CC BY-SA International

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

ただし『Rails』や『Ruby on Rails』という名称、ならびに Rails のロゴ画像は David Heinemeier Hansson の登録商標であり、本ライセンスの対象ではありません。また、本サイトのロゴ画像などの一部は YassLab 社の著作物です。

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

クレジット

YassLab Inc.

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 96.6%
  • HTML 1.8%
  • JavaScript 0.8%
  • CoffeeScript 0.4%
  • SCSS 0.2%
  • CSS 0.2%