Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yasslab/railsguides.jp
📕 Ruby on Railsガイドの公開リポジトリです。1600ページ超えの大型リファレンスとなっています。
https://github.com/yasslab/railsguides.jp
document japanese rails ruby ruby-on-rails
Last synced: about 1 month ago
JSON representation
📕 Ruby on Railsガイドの公開リポジトリです。1600ページ超えの大型リファレンスとなっています。
- Host: GitHub
- URL: https://github.com/yasslab/railsguides.jp
- Owner: yasslab
- License: mit
- Fork: true (ericallam/docrails)
- Created: 2014-09-15T06:14:18.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T01:25:24.000Z (6 months ago)
- Last Synced: 2024-05-01T11:46:46.504Z (6 months ago)
- Topics: document, japanese, rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://railsguides.jp
- Size: 212 MB
- Stars: 358
- Watchers: 29
- Forks: 268
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/yasslab/railsguides.jp/actions)
[](https://railsguides.jp/)
## 『Railsガイド』とは？
『Railsガイド』は [Ruby on Rails Guides](https://guides.rubyonrails.org/) に基づいた大型リファレンスガイドです。
Railsの各機能を体系的に学び、プロダクト開発の生産性を高めたいときに役立ちます。
Ruby on Rails ガイド
https://railsguides.jp/
これから Rails を勉強する方は『Railsチュートリアル』がオススメです。
Ruby on Rails チュートリアル：実例を使ってRailsを学ぼう
https://railstutorial.jp/
## フィードバックについて
Railsガイドを読んで誤字・脱字・誤訳などを見かけましたら、下記の『[ブラウザでRailsガイドの修正を提案する](https://github.com/yasslab/railsguides.jp#%E3%83%96%E3%83%A9%E3%82%A6%E3%82%B6%E3%81%A7rails%E3%82%AC%E3%82%A4%E3%83%89%E3%81%AE%E4%BF%AE%E6%AD%A3%E3%82%92%E6%8F%90%E6%A1%88%E3%81%99%E3%82%8B-%E3%82%AA%E3%82%B9%E3%82%B9%E3%83%A1)』に沿って [Pull Request](https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (プルリク) を送っていただけると嬉しいです 😌
もし原著 (英語版) の間違いを見つけたら **プルリクチャンス** です! Railsガイドの『[Railsのドキュメントに貢献する](https://railsguides.jp/contributing_to_ruby_on_rails.html#rails%E3%81%AE%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AB%E8%B2%A2%E7%8C%AE%E3%81%99%E3%82%8B)』を参考に [:octocat: rails/rails](https://github.com/rails/rails) にプルリクを送ってみましょう 🌐🤝
『[Railsガイド](https://railsguides.jp/)』および『[Rails Guides](https://guides.rubyonrails.org/)』の品質向上に向けて、皆さまのご協力が得られれば嬉しいです 🙏✨
### ブラウザでRailsガイドの修正を提案する (オススメ)
多分これが一番簡単だと思います...!! 😆
1. ブラウザ上で [guides/source/ja](https://github.com/yasslab/railsguides.jp/tree/master/guides/source/ja) を開く
2. 直したいファイルを開く (例: [upgrading_ruby_on_rails.md](https://github.com/yasslab/railsguides.jp/blob/master/guides/source/ja/upgrading_ruby_on_rails.md))
3. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
4. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
5. 修正内容を確認し、問題なければ Create pull request をクリックする
以上で完了です。提案されたRailsガイドの修正はコミッターによって再確認され、問題なければ提案された内容が反映されます。もし問題があってもコミッター側で修正できるので、まずは気軽に提案してみてください :wink:
- 参考スライド: [⛩ OSS入門としてのRailsガイド 📕](https://speakerdeck.com/yasslab/railsguides-as-an-oss-gate)
- [» Railsガイド (日本語) への修正提案が、Rails Guides (英語) にも反映された例](https://github.com/rails/rails/pull/50756)
- [» これまでの修正提案（プルリクエスト）の一覧を見る](https://github.com/yasslab/railsguides.jp/pulls?q=is%3Apr+is%3Aclosed)
## 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](https://github.com/yasslab/railsguides.jp/actions) が走ります。
- CI が通らなかった場合は、該当箇所を修正してください。（`bundle exec rake test`でローカル環境でも確認できます）
- マージされない限り本番環境には反映されないので、PR は気軽に送ってください! 😆👌
## 運営チーム
本リポジトリは『創る』『学ぶ』を支援する [YassLab 株式会社](https://yasslab.jp/ja/) によって制作・運用されております。
📣 【PR】YassLab 社では[Railsガイド協賛プラン](https://railsguides.jp/sponsors)や、[Railsチュートリアル研修支援](https://railstutorial.jp/business)などにも対応しています。まずは無料の導入相談からぜひ! :pray: :sparkling_heart:
YassLab 社以外にも、次の方々が協力してくれました! 🤝✨
様々なご意見・フィードバックありがとうございます! (＞人＜ )✨
### 協力者
- 👥 共同発起人
- [@hachi8833](https://github.com/hachi8833)
- [@yasulab](https://github.com/yasulab)
- 💎 コミッターの皆さん
- [@yui-knk](https://github.com/yui-knk)
- [@riseshia](https://github.com/riseshia)
- [@willnet](https://github.com/willnet)
- 👏 他、[Issues](https://github.com/yasslab/railsguides.jp/issues) や [Pull Request](https://github.com/yasslab/railsguides.jp/graphs/contributors) を送ってくださった多くの方々。
### 支援・協賛
Railsガイドでは、ドキュメントを通してRuby/Railsコミュニティを一緒に支援してくださる企業を募集しております。詳細は「協賛プラン」のページよりご確認ください。
協賛プラン: [https://railsguides.jp/sponsors](https://railsguides.jp/sponsors)
[](https://railsguides.jp/sponsors)
## ライセンス
[](https://creativecommons.org/licenses/by-sa/4.0/deed.ja)
Railsガイドの[コンテンツ部分](https://github.com/yasslab/railsguides.jp/tree/master/guides/source)は[クリエイティブ・コモンズ 表示-継承 4.0 国際](https://creativecommons.org/licenses/by-sa/4.0/deed.ja) (CC BY-SA 4.0) ライセンスに基づいて公開されています。
ただし『Rails』や『Ruby on Rails』という名称、ならびに Rails のロゴ画像は [David Heinemeier Hansson の登録商標](https://rubyonrails.org/trademarks/)であり、本ライセンスの[対象ではありません](https://creativecommons.org/licenses/by-sa/4.0/legalcode#s2b)。また、本サイトのロゴ画像などの一部は [YassLab 社の著作物](https://yasslab.jp/ja/news/japanese-railsguides-logo)です。
[Ruby on Rails のソースコード](https://github.com/rails/rails)は [MIT ライセンス](http://www.opensource.org/licenses/MIT)に基づいて公開されています。
### クレジット
- 原著: [https://edgeguides.rubyonrails.org/#footer](https://edgeguides.rubyonrails.org/#footer)
- 本書: [https://railsguides.jp/#contributors](https://railsguides.jp/#contributors)
[](https://yasslab.jp/ja/)
