aboutsummaryrefslogtreecommitdiffstats
path: root/guides
Commit message (Collapse)AuthorAgeFilesLines
...
* | | | | Indent guides as rails help command output[ci skip]Alberto Almagro2018-11-191-25/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The output from `rails help` actually leaves an empty space when printing the command lists. This commit adapts this guide to have the same format.
* | | | | Merge pull request #34486 from tamarr/masterRafael Mendonça França2018-11-193-3/+772
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | allow right to left styling of docs
| * | | | | allow right to left styling of docs (#3)tamarr2018-11-193-3/+771
| | | | | | | | | | | | | | | | | | | | | | | | * adding rtl css main file and logic to use
* | | | | | [ci skip] Update active_job_basics.mdShota Iguchi2018-11-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | ApplicationJob should be inherits ActiveJob::Base
* | | | | | Change queueing to queuing in docs and comments [skip ci]jacobherrington2018-11-181-1/+1
|/ / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | My spellchecker flagged this as an incorrect spelling, upon further research it appears to be a point of contention in English. Either way might work. After further examination queuing is much more common in the Rails codebase so making this change will serve to standardize the spelling.
* / / / / Replace cache_key with cache_key_with_version on caching_with_rails guides ↵tnantoka2018-11-161-3/+3
|/ / / / | | | | | | | | | | | | [ci skip]
* | | | fix typo on association_basics.md [ci skip]Espartaco Palma2018-11-141-1/+1
| | | |
* | | | Describe how has_many's :dependent option affects #deleteMarcel M. Cary2018-11-131-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I was puzzled about why `collection=` was destroying the removed records on an association with `dependent: :destroy`, even after consulting the documentation for that option. I had to dive into the Active Record source to understand what was going on: eventually `collection=` calls `collection.delete` on the ousted records, and it also uses the `:dependent` option to decide how to remove records. It would have helped me to have mention of this in the documentation for `:dependent`, not just under `collection.delete` (which I found much later). Briefly mention the broader impacts of `:dependent` in the Association Basics guide. [ci skip]
* | | | Add support for UNLOGGED Postgresql tablesJacob Evelyn2018-11-131-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds support for the `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.create_unlogged_tables` setting, which turns `CREATE TABLE` SQL statements into `CREATE UNLOGGED TABLE` statements. This can improve PostgreSQL performance but at the cost of data durability, and thus it is highly recommended that you *DO NOT* enable this in a production environment.
* | | | Revert "Merge pull request #34421 from ↵Ryuta Kamizono2018-11-112-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | albertoalmagro/use-assert-not-instead-of-refute" This reverts commit ab5d5c95ec51c63d58d7e75694af748f165e2228, reversing changes made to ef4f5ef69b5a50c897bbb17f6b36b729dff12e6c.
* | | | Prefer assert_not instead of refute [ci skip]Alberto Almagro2018-11-102-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As mentioned in the contributing to Ruby on Rails guides, we should prefer `assert_not` instead of `refute`. And the best place to start giving example are our bug report templates.. See: https://github.com/rails/rails/blame/master/guides/source/contributing_to_ruby_on_rails.md#L256
* | | | Merge pull request #34373 from shiroginne/masterRobin Dupret2018-11-101-3/+3
|\ \ \ \ | | | | | | | | | | | | | | | | | | | | Fix typo for Action Cable Overview doc [Eileen M. Uchitelle]
| * | | | Update `action_cable_overview.md`: fix typo.Evgeny Sugakov2018-11-101-3/+3
| | | | | | | | | | | | | | | | | | | | [ci skip]
* | | | | Merge pull request #34415 from Ana06/present_associationsGannon McGibbon2018-11-091-1/+2
|\ \ \ \ \ | | | | | | | | | | | | Clarify the validation of present associations
| * | | | | Clarify the validation of present associationsAna María Martínez Gómez2018-11-091-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I think that it is not clear what means that _an association is present_. Add that it is checking that the foreign key is not empty and that the referenced object exists to clarify it.
* | | | | | Merge pull request #32881 from vfonic/update-development-deps-installRobin Dupret2018-11-093-270/+121
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | Docs: Update Development Dependencies Install
| * | | | | | Docs: Update Development Dependencies InstallViktor Fonic2018-11-093-270/+121
| | |/ / / / | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Move all the testing related stuff to the contributing guide and redirect the reader to this guide once the installation process is finished as running tests is the logical next step. * Group documentation instructions by OS, not by gem * It eases the installation process and lessen the need to scroll through the guide * There's still a list of all additional services required for each of the gems above the instructions for each OS. * Also update a bit the instructions * Update some package names * Add `yarn` to the package list for Arch Linux and FreeBSD * Use `dnf` instead of `yum` for Fedora and CentOS * Advise the user to use `brew bundle` on macOS to lessen the maintenance burden for this OS and ease the process for the user. [ci skip]
* | | | | | Amend CVE note and security guide section wordingsGannon McGibbon2018-11-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Reword first sentence of dep management and CVE section of security guide. Also, reword and move gemspec notes above deps. [ci skip]
* | | | | | Add CVE note to security guide and gemspecsGannon McGibbon2018-11-061-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | [ci skip]
* | | | | | Fix typoNick Coyne2018-11-051-1/+1
|/ / / / / | | | | | | | | | | Just a small typo fix for the recently merged #34257
* | | | | Make i18n locale setting docs use around_actionGannon McGibbon2018-10-311-15/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changes `I18n.locale` assignment in docs to use `I18n.with_locale` in `around_action` to ensure locale resetting after action processing. [ci skip] [Gannon McGibbon + Leonardo Tegon]
* | | | | Merge pull request #34349 from yahonda/restore_encoding_utf8mb4Ryuta Kamizono2018-10-301-0/+1
|\ \ \ \ \ | | | | | | | | | | | | Restore `encoding: utf8mb4` in database.yml
| * | | | | Restore `encoding: utf8mb4` in database.ymlYasuo Honda2018-10-301-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | rails/rails#33853 and rails/rails#33929 removed `encoding: utf8mb4` from database.yml since at that time MySQL 5.1 is supported with the master branch. Since MySQL 5.1 has been dropped, we can restore `encoding: utf8mb4` in database.yml
* | | | | | Merge pull request #34338 from ↵Ryuta Kamizono2018-10-301-2/+2
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | malclocke/document_exception_class_for_restrict_with_exception Document exception from restrict_with_exception [ci skip]
| * | | | | | Document exception from restrict_with_exception [ci skip]Malcolm Locke2018-10-291-2/+2
| | | | | | |
* | | | | | | Merge pull request #34335 from robin850/update-bug-report-templatesRyuta Kamizono2018-10-2911-87/+11
|\ \ \ \ \ \ \ | |/ / / / / / |/| | | | | | Update bug report templates
| * | | | | | Update bug report templatesRobin Dupret2018-10-2811-87/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Given that Bundler 1.10 was released back in 2015, we can assume that people are at least on this version or a higher one so there is no need to ask people to upgrade. Also, given that Rails 5.0 supports Ruby 2.2+ and given that this version come with Minitest 5.4.3 bundled, we don't need to ensure backward compatibility with Minitest 4.
* | | | | | | Use release dates for versions in Rails Guides indexOlivier Lacan2018-10-271-11/+11
| |/ / / / / |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We repeat the phrase "Release Notes" even though release note are listed under a... "Release Notes" category already. With this change, instead of repeating ourselves, we can give people a sense of the recency of each release by simply listing the month and year of each release. This is a follow-up to #34265 as suggested by @jeremy. [ci skip]
* | | | | | Document `deep_interpolation` parameter for bulk lookupsOliver Günther2018-10-251-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Bulk lookups are sort of an edge case, I have not heard of them until a colleague of mine decided to dynamically iterate over a growing set of translations and receiving them in bulk as a hash with `I18n.t 'welcome'` as in the example above. When passing an interpolation to these bulk lookups, they will only be performed when also passing `deep_interpolation: true`. **Without passing `deep_interpolation` flag:** ```ruby I18n.t 'welcome', app_name: 'book store' # => {:title=>"Welcome!", :content=>"Welcome to the %{app_name}"} **With passing `deep_interpolation`:** I18n.t 'welcome', deep_interpolation: true, app_name: 'book store' # => {:title=>"Welcome!", :content=>"Welcome to the book store"} ``` I found this digging in the I18n lookup backend, the flag is listed on [I18n's Rubydoc](https://www.rubydoc.info/github/svenfuchs/i18n/master/I18n) but not otherwise listed. Since bulk lookups are mentioned here, I suggest to add a note with this flag along with it.
* | | | | | Merge pull request #34080 from baerjam/add-email-observer-to-guidesGannon McGibbon2018-10-231-5/+24
|\ \ \ \ \ \ | |/ / / / / |/| | | | | Add observing emails to action mailer guide [ci skip]
| * | | | | Add observing emails to action mailer guide [ci skip]James Baer2018-10-041-5/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds information on using email observer classes with Action Mailer. Intercepting Emails section is changed to "Intercepting and Observing Emails", with a sub-section on each topic. Also includes slight reworking of the Intercepting Emails summary to flow with the new structure.
* | | | | | Fully remove duplicated upgrade information [ci skip]Alberto Almagro2018-10-231-5/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | On #34261 we removed the whole upgrade section. This warning is also included in the Upgrade guides [here](https://github.com/rails/rails/blame/master/guides/source/upgrading_ruby_on_rails.md#L1390) and should also be removed.
* | | | | | Fix typo of duplicated `the` [ci skip]ohbarye2018-10-241-1/+1
| | | | | |
* | | | | | Fix PullRequest link to datetime_field changes on Rails 5.1 Release Notestzmfreedom2018-10-231-1/+1
| | | | | |
* | | | | | Merge pull request #34284 from ↵Rafael França2018-10-231-5/+1
|\ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | bogdanvlviv/remove-mention-about-javascript-from-generators-guide Remove mentions about `javascripts` option from the guide about generators [ci skip]
| * | | | | | Remove mentions about `javascripts` option from the guide about generators ↵bogdanvlviv2018-10-221-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [ci skip] This option is unused since #33079. Follow up #34277
* | | | | | | Merge pull request #34261 from ↵Ryuta Kamizono2018-10-231-57/+0
|\ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | matildasmeds/guides_remove_upgrade_section_from_asset_pipeline_guide Remove "Upgrading from Old Versions" from Asset Pipeline Guide [skip ci]
| * | | | | | | Remove "Upgrading Old Versions" from Asset Pipeline Guide [skip ci]Matilda Smeds2018-10-191-57/+0
| | |_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | * How to upgrade Rails 2.x/3.2 not relevant for this Guide * All configuration changes are already included in Upgrading Ruby on Rails Guide
* | | | | | | [ci skip] Fix #33914Raghu Kamat2018-10-221-3/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit removes the dependent: :destroy option from the belong_to example since there is a warning associated with the usage of dependent: :destroy along with belongs_to. Based on the feedback on the issue #33914, I replaced dependent: :destroy with touch: :books_updated_at which will make the example consistent with the example that already exists on that page. * Also Removing the touch option from the belong_to scopes example as the option doesnt have any relation to association scope.
* | | | | | | Merge pull request #34241 from gmcgibbon/clarify_i18n_load_paths_gotchaRafael França2018-10-221-1/+3
|\ \ \ \ \ \ \ | |_|/ / / / / |/| | | | | | Clarify i18n load paths gotcha
| * | | | | | [ci skip] Clarify load_paths behaviourGannon McGibbon2018-10-221-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Clarify `I18n.load_paths` vs `Rails.application.config.i18n.load_paths` behaviour. [Gannon McGibbon + Alberto Almagro Sotelo]
| * | | | | | [ci skip] Remove explicit to_s for consistency with other exampleTrevor Wistaff2018-10-161-1/+1
| | | | | | |
* | | | | | | Remove `javascripts` and `javascript_engine` options for generatorsbogdanvlviv2018-10-221-2/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | It is unused since #33079
* | | | | | | Replace outdated Rails Guides logoOlivier Lacan2018-10-193-1/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The previous version wasn’t matching the Rails Guides logo source file listed at https://github.com/rails/homepage/blob/master/materials/rails_guides_logo.psd somehow. It was also a GIF when an 8-bit PNG results in a smaller file (2KB vs 4KB) which should be just as widely compatible with browsers. And that’s just for the 1x version. I added a new 2x version for “retina” or high-density displays and a CSS @media query to progressively enhance with this high density version of the logo. I’ve ensured that this query is supported across browsers by using vendor-specific versions when necessary. See: https://caniuse.com/#feat=css-media-resolution [ci skip]
* | | | | | | Shorten unnecessarily long names for GuidesOlivier Lacan2018-10-191-16/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The names are only used in the Guides Index overlay and several of them are longer than they need to be. For example “Ruby on Rails” is mentioned over and over again in the Release Notes section although these are obviously all Rails versions we’re listing. There’s a Maintenance Policy category with a Maintenance Policy article which is redundant. Policies makes much more sense as a category. Similarly, Contributing to Ruby on Rails is both a category and an article. “Contributions” is a better category title. “Ruby on Rails Guides Guidelines” is a gigantic mouthful. We are *in* the Rails Guides, we don’t need to specify what guides we’re talking about here. As a final added advantage, all of these shortenings make the index much easier to parse in order to find an article. [ci skip]
* | | | | | | Use CSS flexbox for Guides index menuOlivier Lacan2018-10-192-20/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This notably allows us to tile each category without pushing the page down vertically as much as we previously did on any viewport wider than mobile sizes. It also means we can fit more guides which will become useful in the future since we have several new guides in the work. Finally the new layout allows three clearly distinct columns to emerge: - Start Here and Rails basics: Models, Views, Controllers, Other Components - Digging Deeper, Extending Rails, Contributing, Maintenance - Release Notes Having Release Notes shoot back up to the top of the third column is great because that makes finding the latest released version and its associated release notes much easier without having to scroll down a bunch. [ci skip]
* | | | | | | Merge pull request #34257 from olivierlacan/verbose-query-logs-guidesRichard Schneeman2018-10-191-6/+43
|\ \ \ \ \ \ \ | | | | | | | | | | | | | | | | Add guides section on verbose query logs to Debugging
| * | | | | | | Add guides section on verbose query logs to DebuggingOlivier Lacan2018-10-191-6/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since this is a useful tool in debugging it made sense to document its existence and usage, especially in the console where it's disabled by default. [ci skip]
* | | | | | | | Fix typo in testing guideanthonygharvey2018-10-171-1/+1
|/ / / / / / /
* | | | | | | Remove and flip `index: true` for `references` in the doc [ci skip]Ryuta Kamizono2018-10-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Follow up #32146.