Commit Graph

62 Commits

Author SHA1 Message Date
Missy Davies
d49a3abc01 Capitalize headings to match style guidelines
Fix all headings to follow Rails Guides Guidelines
2022-10-17 17:01:28 -10:00
Datt Dongare
638e9e7a7a Fix rdoc inconsistency 2022-10-02 09:28:53 +05:30
Ari Kardasis
d842f463f6 Clarifications for the Plugins Rails Guide
- Provides instructions to modify yaffle.gemspec
- adds missing require statements
2022-09-12 16:35:39 -04:00
Rafael Mendonça França
18707ab17f
Standardize nodoc comments 2021-07-29 21:18:07 +00:00
John Bampton
c02068bad8 docs: fix grammar and spelling [ci skip] 2021-04-15 18:51:29 +10:00
Jonathan Hefner
cb0da4f817 Fix typos, grammar, and formatting [ci-skip]
This is a collection of minor superficial improvements.  It does not
include any significant content changes.
2020-12-28 12:05:53 -06:00
Jonathan Hefner
cb563a27de Split code snippets by context [ci-skip]
This provides a stronger visual cue that the code in these snippets
belongs in different contexts (e.g. separate files).
2020-12-25 10:53:12 -06:00
Jonathan Hefner
3c9d7a268f Use irb code fences where applicable [ci-skip]
Using `irb` code fences and the appropriate prompt syntax results in
better syntax highlighting.
2020-11-01 16:29:18 -06:00
Michael Hagar
55f82e9a7d fix markdown syntax error
Update guides/source/plugins.md

Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
2020-08-14 14:01:55 -05:00
Jonathan Hefner
3a90f12317 Use appropriate code fences [ci skip]
Follow-up to #39620.

This commit changes a few overlooked code fences to `bash`, and changes
a few IRB session snippets to be only Ruby code with a `ruby` fence.
2020-07-08 14:51:57 -05:00
Jonathan Hefner
481035fba0 Use bash code fences and prompts for shell code [ci skip]
Follow-up to #39594, which added CSS in order to select shell commands
sans prompts on triple-click.

This commit adds several bash code fences and prompts where they were
missing, and removes a few where they were inappropriate.
2020-06-13 19:27:30 -05:00
Rafael França
3c1ad16813
Merge pull request #35526 from igorkasyanchuk/improve_new_plugin_documentation
added instructions how to release rails a plugin (gem)
2020-03-30 15:29:06 -04:00
Haroon Ahmed
db1ae8cbb4 remove reference to global rails command and replace with bin/rails 2019-12-27 19:32:37 +00:00
Juanjo Bazán
b24190807d update https urls [ci skip] 2019-10-03 11:01:32 +02:00
Igor Kasyanchuk
b9f2e24902 added instructions how to release rails plugins (gems) 2019-03-07 23:50:37 -08:00
Matthew Draper
ec387c6dd9
Merge pull request #33229 from albertoalmagro/albertoalmagro/prefer-rails-command-over-bin-rails
Prefer rails command over bin/rails
2018-07-25 04:10:29 +09:30
Paul McMahon
7b9c19d94b Rails guides are now served over https
http links will be redirected to the https version, but still better to
just directly link to the https version.
2018-07-24 11:29:31 +09:00
Alberto Almagro
40b209db53 Recommend use of rails over bin/rails
As discussed in #33203 rails command already looks for, and runs,
bin/rails if it is present.

We were mixing recommendations within guides and USAGE guidelines,
in some files we recommended using rails, in others bin/rails and
in some cases we even had both options mixed together.
2018-07-06 22:46:35 +02:00
Anthony Crumley
258670244d Added a lot of Oxford commas
[ci skip] A regular expression was used to find a lot of missing Oxford
commas and add them.  The regular expression was as follows.

", ([a-zA-Z0-9.\`:'\"]+ ){1,6}(or|and) "
2018-05-10 12:46:06 -05:00
Yauheni Dakuka
de2afdc457 Cosmetic fixes [ci skip] 2017-10-06 09:02:56 +03:00
Yauheni Dakuka
5657280a62 new missing backquotes [ci skip] 2017-09-25 15:08:08 +03:00
Yauheni Dakuka
e484a2d109 Update plugins.md [ci skip] 2017-09-17 15:40:11 +03:00
Yauheni Dakuka
e9f71e2451 missing backquotes [ci skip] 2017-08-22 08:51:39 +03:00
bogdanvlviv
87666e5411
Update guides/source/plugins.md [ci skip] 2017-08-15 09:47:29 +03:00
Genadi Samokovarov
b6b0c99ff3 Use mattr_accessor default: option throughout the project 2017-06-03 13:52:48 +03:00
Vipul A M
18e599940a
When referring to Rails, be consistent in usage of capitalized form, unless it is used in context of a command like bin/rails or the rails directory [ci skip] 2016-08-19 14:17:07 +05:30
Santosh Wadghule
d8575289a2 rails -> Rails [ci skip] 2016-07-12 12:21:36 +05:30
Gaurav Sharma
352a8892fd use bin/rails default instead of rake commands [ci skip]
I go through the `http://edgeguides.rubyonrails.org/` and found `rake` commands in various files that are in RAILS 5.0 implement by `bin/rails` command. I try to change all that can be directly use `bin/rails …`
2016-01-19 23:47:14 +05:30
yuuji.yaginuma
0e7c08d189 use bin/test in plugins guide [ci skip]
`bin/test` can use the same API as the `bin/rails test`, since it is possible to run a flexible test than rake,
I think better to use a guide even `bin/test`.
2015-12-22 09:02:24 +09:00
Genadi Samokovarov
2067fff9e3 Introduce ApplicationRecord, an Active Record layer supertype
It's pretty common for folks to monkey patch `ActiveRecord::Base` to
work around an issue or introduce extra functionality. Instead of
shoving even more stuff in `ActiveRecord::Base`, `ApplicationRecord` can
hold all those custom work the apps may need.

Now, we don't wanna encourage all of the application models to inherit
from `ActiveRecord::Base`, but we can encourage all the models that do,
to inherit from `ApplicationRecord`.

Newly generated applications have `app/models/application_record.rb`
present by default. The model generators are smart enough to recognize
that newly generated models have to inherit from `ApplicationRecord`,
but only if it's present.
2015-12-16 10:30:09 +01:00
Jesse Doyle
6195747406 [ci skip] fix inconsistent indentation 2015-11-17 14:39:03 -07:00
yuuji.yaginuma
c98fd25120 remove link to outdated article in plugins guide [ci skip]
linked article is a description of the plugins in Rails 2.1.
2015-08-28 09:18:08 +09:00
yuuji.yaginuma
71dcc40a2c use public Module#include instead of send :include [ci skip] 2015-03-09 23:01:51 +09:00
Vipul A M
5cfaf5a46e - Changed IN to ON in markdown renderer condition
- Changed `IN` to `ON` in all note sentences in guides.
2015-01-14 11:52:13 +05:30
Xavier Noria
7702974281 warn about reading guides in GitHub
References #18148.
2014-12-23 23:32:50 +01:00
yuuji.yaginuma
1581348f28 bin/rake does not exist in plugin directory [ci skip] 2014-12-22 13:45:03 +09:00
David Elliott
21ba9b11f9 technical correction in guides under 'Generating an engine'
`bin/rails` would not exist outside of a rails project
2014-09-28 09:20:32 -07:00
Yukio Mizuta
629bb0e34d [ci skip] Update plugin doc with the latest rails 2014-08-18 21:07:01 -07:00
yuuji.yaginuma
784f2c5b31 [ci skip] Fix broken url in plugins guide 2014-08-12 18:07:07 +09:00
Guillermo Álvarez Fernández
b20d11133d Fix typo in plugins doc 2014-08-08 15:13:40 +02:00
Josef Šimánek
981dda53db Use generated binstubs in guides examples.
[ci skip]
2014-05-20 13:29:18 +02:00
ch33hau
ac85125164 [skip ci] Standardized punctuation. 2014-02-25 12:31:19 +08:00
Jon Leighton
ff7ab3bc78 Automatically maintain test database schema
* Move check from generated helper to test_help.rb, so that all
  applications can benefit
* Rather than just raising when the test schema has pending migrations,
  try to load in the schema and only raise if there are pending
  migrations afterwards
* Opt out of the check by setting
  config.active_record.maintain_test_schema = false
* Deprecate db:test:* tasks. The test helper is now fully responsible
  for maintaining the test schema, so we don't need rake tasks for this.
  This is also a speed improvement since we're no longer reloading the
  test database on every call to "rake test".
2014-01-02 13:49:00 +00:00
Ben Lewis
ded25a3353 Formatting, capitalization, and punctuation fixes [ci skip]
Second try on this commit.
2013-12-04 07:34:22 -07:00
Ulysse Carion
e2de7dc5ba Call rails plugin new yaffle in the plugins guide. [ci skip]
It's confusing to not explicitly do this step.
2013-10-08 08:14:51 -07:00
Harshad Sabne
3988dcc4eb [ci skip] Update plugins.md
Highlighted code.
2013-09-14 17:56:08 +05:30
Xavier Noria
b77f25cb84 cleans the guides sources from fancy non-ASCII stuff 2013-08-23 17:59:11 +02:00
Rajarshi Das
d49c00027e fixes the test case of that plugins 2013-07-18 11:04:21 +05:30
Manish Valechha
879c18df83 Fix typo in rails plugins guide 2013-01-27 00:26:43 -04:00
Steve Klabnik
ed78770b1a Remove references to Rails versions.
There's no reason for guides to reference old behaviors. They should
be current as of the versions of Rails that they ship with, and including
older information just clutters thing.

I discussed this change with @fxn and he agrees.
2012-12-07 23:20:35 -08:00