aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKasper Timm Hansen <kaspth@gmail.com>2019-03-09 22:54:21 +0100
committerGitHub <noreply@github.com>2019-03-09 22:54:21 +0100
commit0fc13977841d0fb5aa78d5bd86fa9a540477009f (patch)
treebbd322bc9be143e5426682442aee1dc7d61c8c32
parent6c0afaca98758e87a05752e1f4f8f2029d6d9664 (diff)
parente3ef12b310abdbc1688c3dc4c9b7c48209ce6da2 (diff)
downloadrails-0fc13977841d0fb5aa78d5bd86fa9a540477009f.tar.gz
rails-0fc13977841d0fb5aa78d5bd86fa9a540477009f.tar.bz2
rails-0fc13977841d0fb5aa78d5bd86fa9a540477009f.zip
Merge pull request #35559 from ashishprajapati/ashishprajapati/important_textual_improvements
Added missing guide links in documentation and minor wording fix
-rw-r--r--actionmailer/README.rdoc2
-rw-r--r--actionpack/README.rdoc1
-rw-r--r--actionview/README.rdoc2
-rw-r--r--activejob/README.md3
-rw-r--r--activemodel/README.rdoc2
-rw-r--r--activerecord/README.rdoc2
-rw-r--r--activestorage/README.md2
-rw-r--r--activesupport/README.rdoc1
8 files changed, 14 insertions, 1 deletions
diff --git a/actionmailer/README.rdoc b/actionmailer/README.rdoc
index 88cade3dae..0db4b2668b 100644
--- a/actionmailer/README.rdoc
+++ b/actionmailer/README.rdoc
@@ -13,6 +13,8 @@ Additionally, an Action Mailer class can be used to process incoming email,
such as allowing a blog to accept new posts from an email (which could even
have been sent from a phone).
+You can read more about Action Mailer in the {Action Mailer Basics}[https://edgeguides.rubyonrails.org/action_mailer_basics.html] guide.
+
== Sending emails
The framework works by initializing any instance variables you want to be
diff --git a/actionpack/README.rdoc b/actionpack/README.rdoc
index 5df6933115..fe85bc5b7a 100644
--- a/actionpack/README.rdoc
+++ b/actionpack/README.rdoc
@@ -23,6 +23,7 @@ by default and Action View rendering is implicitly triggered by Action
Controller. However, these modules are designed to function on their own and
can be used outside of Rails.
+You can read more about Action Pack in the {Action Controller Overview}[https://guides.rubyonrails.org/action_controller_overview.html] guide.
== Download and installation
diff --git a/actionview/README.rdoc b/actionview/README.rdoc
index a9399752a1..ba50c67024 100644
--- a/actionview/README.rdoc
+++ b/actionview/README.rdoc
@@ -5,6 +5,8 @@ view helpers that assist when building HTML forms, Atom feeds and more.
Template formats that Action View handles are ERB (embedded Ruby, typically
used to inline short Ruby snippets inside HTML), and XML Builder.
+You can read more about Action View in the {Action View Overview}[https://edgeguides.rubyonrails.org/action_view_overview.html] guide.
+
== Download and installation
The latest version of Action View can be installed with RubyGems:
diff --git a/activejob/README.md b/activejob/README.md
index d17711c0be..462d319992 100644
--- a/activejob/README.md
+++ b/activejob/README.md
@@ -1,4 +1,4 @@
-# Active Job -- Make work happen later
+# Active Job – Make work happen later
Active Job is a framework for declaring jobs and making them run on a variety
of queuing backends. These jobs can be everything from regularly scheduled
@@ -17,6 +17,7 @@ about API differences between Delayed Job and Resque. Picking your queuing
backend becomes more of an operational concern, then. And you'll be able to
switch between them without having to rewrite your jobs.
+You can read more about Active Job in the [Active Job Basics](https://edgeguides.rubyonrails.org/active_job_basics.html) guide.
## Usage
diff --git a/activemodel/README.rdoc b/activemodel/README.rdoc
index 5ac0b29cff..f9370d8de0 100644
--- a/activemodel/README.rdoc
+++ b/activemodel/README.rdoc
@@ -5,6 +5,8 @@ They allow for Action Pack helpers to interact with non-Active Record models,
for example. Active Model also helps with building custom ORMs for use outside of
the Rails framework.
+You can read more about Active Model in the {Active Model Basics}[https://edgeguides.rubyonrails.org/active_model_basics.html] guide.
+
Prior to Rails 3.0, if a plugin or gem developer wanted to have an object
interact with Action Pack helpers, it was required to either copy chunks of
code from Rails, or monkey patch entire helpers to make them handle objects
diff --git a/activerecord/README.rdoc b/activerecord/README.rdoc
index 26cdff9422..be573af4ba 100644
--- a/activerecord/README.rdoc
+++ b/activerecord/README.rdoc
@@ -13,6 +13,8 @@ columns. Although these mappings can be defined explicitly, it's recommended
to follow naming conventions, especially when getting started with the
library.
+You can read more about Active Record in the {Active Record Basics}[https://edgeguides.rubyonrails.org/active_record_basics.html] guide.
+
A short rundown of some of the major features:
* Automated mapping between classes and tables, attributes and columns.
diff --git a/activestorage/README.md b/activestorage/README.md
index e5f64c97af..7a437d4014 100644
--- a/activestorage/README.md
+++ b/activestorage/README.md
@@ -6,6 +6,8 @@ Files can be uploaded from the server to the cloud or directly from the client t
Image files can furthermore be transformed using on-demand variants for quality, aspect ratio, size, or any other [MiniMagick](https://github.com/minimagick/minimagick) or [Vips](https://www.rubydoc.info/gems/ruby-vips/Vips/Image) supported transformation.
+You can read more about Active Storage in the [Active Storage Overview](https://edgeguides.rubyonrails.org/active_storage_overview.html) guide.
+
## Compared to other storage solutions
A key difference to how Active Storage works compared to other attachment solutions in Rails is through the use of built-in [Blob](https://github.com/rails/rails/blob/master/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/master/activestorage/app/models/active_storage/attachment.rb) models (backed by Active Record). This means existing application models do not need to be modified with additional columns to associate with files. Active Storage uses polymorphic associations via the `Attachment` join model, which then connects to the actual `Blob`.
diff --git a/activesupport/README.rdoc b/activesupport/README.rdoc
index fed636937b..d8d25d86c8 100644
--- a/activesupport/README.rdoc
+++ b/activesupport/README.rdoc
@@ -5,6 +5,7 @@ extensions that were found useful for the Rails framework. These additions
reside in this package so they can be loaded as needed in Ruby projects
outside of Rails.
+You can read more about the extensions in the {Active Support Core Extensions}[https://edgeguides.rubyonrails.org/active_support_core_extensions.html] guide.
== Download and installation