1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Normalize on 'After reading this guide, you will know:'

We have three or four different introduction sentences to the guides.
After this commit, we use the same one everywhere.
This commit is contained in:
Steve Klabnik 2012-11-29 14:25:02 -08:00
parent d168d234e3
commit d16a1b9e8b
37 changed files with 80 additions and 28 deletions

View file

@ -1,7 +1,9 @@
Action Controller Overview
==========================
In this guide you will learn how controllers work and how they fit into the request cycle in your application. After reading this guide, you will be able to:
In this guide you will learn how controllers work and how they fit into the request cycle in your application.
After reading this guide, you will know:
* Follow the flow of a request through a controller.
* Understand why and how to store data in the session or cookies.

View file

@ -3,6 +3,8 @@ Action Mailer Basics
This guide should provide you with all you need to get started in sending and receiving emails from and to your application, and many internals of Action Mailer. It also covers how to test your mailers.
After reading this guide, you will know:
--------------------------------------------------------------------------------
Introduction

View file

@ -1,7 +1,7 @@
Action View Overview
====================
In this guide you will learn:
After reading this guide, you will know:
* What Action View is and how to use it with Rails.
* How best to use templates, partials, and layouts.

View file

@ -3,6 +3,8 @@ Active Model Basics
This guide should provide you with all you need to get started using model classes. Active Model allows for Action Pack helpers to interact with non-Active Record models. Active Model also helps building custom ORMs for use outside of the Rails framework.
After reading this guide, you will know:
--------------------------------------------------------------------------------
Introduction

View file

@ -1,7 +1,9 @@
Active Record Basics
====================
This guide is an introduction to Active Record. After reading this guide we hope that you'll learn:
This guide is an introduction to Active Record.
After reading this guide, you will know:
* What Object Relational Mapping and Active Record are and how they are used in Rails.
* How Active Record fits into the Model-View-Controller paradigm.

View file

@ -1,7 +1,9 @@
Active Record Query Interface
=============================
This guide covers different ways to retrieve data from the database using Active Record. By referring to this guide, you will be able to:
This guide covers different ways to retrieve data from the database using Active Record.
After reading this guide, you will know:
* Find records using a variety of methods and conditions.
* Specify the order, retrieved attributes, grouping, and other properties of the found records.

View file

@ -3,7 +3,7 @@ Active Record Validations and Callbacks
This guide teaches you how to hook into the life cycle of your Active Record objects. You will learn how to validate the state of objects before they go into the database, and how to perform custom operations at certain points in the object life cycle.
After reading this guide and trying out the presented concepts, we hope that you'll be able to:
After reading this guide, you will know:
* Understand the life cycle of Active Record objects.
* Use the built-in Active Record validation helpers.

View file

@ -5,7 +5,7 @@ Active Support is the Ruby on Rails component responsible for providing Ruby lan
It offers a richer bottom-line at the language level, targeted both at the development of Rails applications, and at the development of Ruby on Rails itself.
By referring to this guide you will learn the extensions to the Ruby core classes and modules provided by Active Support.
After reading this guide, you will know:
--------------------------------------------------------------------------------

View file

@ -3,7 +3,9 @@ Active Support Instrumentation
Active Support is a part of core Rails that provides Ruby language extensions, utilities and other things. One of the things it includes is an instrumentation API that can be used inside an application to measure certain actions that occur within Ruby code, such as that inside a Rails application or the framework itself. It is not limited to Rails, however. It can be used independently in other Ruby scripts if it is so desired.
In this guide, you will learn how to use the instrumentation API inside of Active Support to measure events inside of Rails and other Ruby code. We cover:
In this guide, you will learn how to use the instrumentation API inside of Active Support to measure events inside of Rails and other Ruby code.
After reading this guide, you will know:
* What instrumentation can provide.
* The hooks inside the Rails framework for instrumentation.

View file

@ -3,6 +3,8 @@ API Documentation Guidelines
This guide documents the Ruby on Rails API documentation guidelines.
After reading this guide, you will know:
--------------------------------------------------------------------------------
RDoc

View file

@ -2,7 +2,8 @@ The Asset Pipeline
==================
This guide covers the asset pipeline introduced in Rails 3.1.
By referring to this guide you will be able to:
After reading this guide, you will know:
* Understand what the asset pipeline is and what it does.
* Properly organize your application assets.

View file

@ -1,7 +1,9 @@
Active Record Associations
==========================
This guide covers the association features of Active Record. By referring to this guide, you will be able to:
This guide covers the association features of Active Record.
After reading this guide, you will know:
* Declare associations between Active Record models.
* Understand the various types of Active Record associations.

View file

@ -3,7 +3,7 @@ Caching with Rails: An overview
This guide will teach you what you need to know about avoiding that expensive round-trip to your database and returning what you need to return to the web clients in the shortest time possible.
After reading this guide, you should be able to use and configure:
After reading this guide, you will know:
* Page, action, and fragment caching.
* Sweepers.

View file

@ -3,6 +3,8 @@ The Rails Command Line
Rails comes with every command line tool you'll need to
After reading this guide, you will know:
* Create a Rails application.
* Generate models, controllers, database migrations, and unit tests.
* Start a development server.

View file

@ -1,7 +1,9 @@
Configuring Rails Applications
==============================
This guide covers the configuration and initialization features available to Rails applications. By referring to this guide, you will be able to:
This guide covers the configuration and initialization features available to Rails applications.
After reading this guide, you will know:
* Adjust the behavior of your Rails applications.
* Add additional code to be run at application start time.

View file

@ -1,7 +1,9 @@
Contributing to Ruby on Rails
=============================
This guide covers ways in which _you_ can become a part of the ongoing development of Ruby on Rails. After reading it, you should be familiar with:
This guide covers ways in which _you_ can become a part of the ongoing development of Ruby on Rails.
After reading this guide, you will know:
* Using GitHub to report issues.
* Cloning master and running the test suite.

View file

@ -1,7 +1,9 @@
Debugging Rails Applications
============================
This guide introduces techniques for debugging Ruby on Rails applications. By referring to this guide, you will be able to:
This guide introduces techniques for debugging Ruby on Rails applications.
After reading this guide, you will know:
* Understand the purpose of debugging.
* Track down problems and issues in your application that your tests aren't identifying.

View file

@ -3,6 +3,8 @@ Development Dependencies Install
This guide covers how to setup an environment for Ruby on Rails core development.
After reading this guide, you will know:
--------------------------------------------------------------------------------
The Easy Way

View file

@ -1,7 +1,9 @@
Getting Started with Engines
============================
In this guide you will learn about engines and how they can be used to provide additional functionality to their host applications through a clean and very easy-to-use interface. You will learn the following things in this guide:
In this guide you will learn about engines and how they can be used to provide additional functionality to their host applications through a clean and very easy-to-use interface.
After reading this guide, you will know:
* What makes an engine.
* How to generate an engine.

View file

@ -3,7 +3,7 @@ Form Helpers
Forms in web applications are an essential interface for user input. However, form markup can quickly become tedious to write and maintain because of form control naming and their numerous attributes. Rails deals away with these complexities by providing view helpers for generating form markup. However, since they have different use-cases, developers are required to know all the differences between similar helper methods before putting them to use.
In this guide you will:
After reading this guide, you will know:
* Create search forms and similar kind of generic forms not representing any specific model in your application.
* Make model-centric forms for creation and editing of specific database records.

View file

@ -3,7 +3,7 @@ Creating and Customizing Rails Generators & Templates
Rails generators are an essential tool if you plan to improve your workflow. With this guide you will learn how to create generators and customize existing ones.
In this guide you will:
After reading this guide, you will know:
* Learn how to see which generators are available in your application.
* Create a generator using templates.

View file

@ -1,8 +1,9 @@
Getting Started with Rails
==========================
This guide covers getting up and running with Ruby on Rails. After reading it,
you should be familiar with:
This guide covers getting up and running with Ruby on Rails.
After reading this guide, you will know:
* Installing Rails, creating a new Rails application, and connecting your
application to a database.

View file

@ -19,6 +19,8 @@ In the process of _localizing_ your application you'll probably want to do the f
This guide will walk you through the I18n API and contains a tutorial on how to internationalize a Rails application from the start.
After reading this guide, you will know:
--------------------------------------------------------------------------------
NOTE: The Ruby I18n framework provides you with all necessary means for internationalization/localization of your Rails application. You may, however, use any of various plugins and extensions available, which add additional functionality or features. See the Rails [I18n Wiki](http://rails-i18n.org/wiki) for more information.

View file

@ -4,6 +4,8 @@ The Rails Initialization Process
This guide explains the internals of the initialization process in Rails
as of Rails 4. It is an extremely in-depth guide and recommended for advanced Rails developers.
After reading this guide, you will know:
* Using `rails server`.
--------------------------------------------------------------------------------

View file

@ -3,6 +3,8 @@ Layouts and Rendering in Rails
This guide covers the basic layout features of Action Controller and Action View. By referring to this guide, you will be able to:
After reading this guide, you will know:
* Use the various rendering methods built into Rails.
* Create layouts with multiple content sections.
* Use partials to DRY up your views.

View file

@ -6,7 +6,7 @@ database schema over time. Rather than write schema modifications in pure SQL,
migrations allow you to use an easy Ruby DSL to describe changes to your
tables.
In this guide, you'll learn all about migrations including:
After reading this guide, you will know:
* The generators you can use to create them.
* The methods Active Record provides to manipulate your database.

View file

@ -3,7 +3,7 @@ Rails nested model forms
Creating a form for a model _and_ its associations can become quite tedious. Therefore Rails provides helpers to assist in dealing with the complexities of generating these forms _and_ the required CRUD operations to create, update, and destroy associations.
In this guide you will:
After reading this guide, you will know:
* do stuff.

View file

@ -2,7 +2,9 @@ Performance Testing Rails Applications
======================================
This guide covers the various ways of performance testing a Ruby on Rails
application. By referring to this guide, you will be able to:
application.
After reading this guide, you will know:
* Understand the various types of benchmarking and profiling metrics.
* Generate performance and benchmarking tests.

View file

@ -7,7 +7,7 @@ A Rails plugin is either an extension or a modification of the core framework. P
* a segmented architecture so that units of code can be fixed or updated on their own release schedule
* an outlet for the core developers so that they dont have to include every cool new feature under the sun
After reading this guide you should be familiar with:
After reading this guide, you will know:
* Creating a plugin from scratch.
* Writing and running tests for the plugin.

View file

@ -3,7 +3,7 @@ Rails Application Templates
Application templates are simple Ruby files containing DSL for adding gems/initializers etc. to your freshly created Rails project or an existing Rails project.
By referring to this guide, you will be able to:
After reading this guide, you will know:
* Use templates to generate/customize Rails applications.
* Write your own reusable application templates using the Rails template API.

View file

@ -1,7 +1,9 @@
Rails on Rack
=============
This guide covers Rails integration with Rack and interfacing with other Rack components. By referring to this guide, you will be able to:
This guide covers Rails integration with Rack and interfacing with other Rack components.
After reading this guide, you will know:
* Create Rails Metal applications.
* Use Rack Middlewares in your Rails applications.

View file

@ -1,7 +1,9 @@
Rails Routing from the Outside In
=================================
This guide covers the user-facing features of Rails routing. By referring to this guide, you will be able to:
This guide covers the user-facing features of Rails routing.
After reading this guide, you will know:
* Understand the code in `routes.rb`.
* Construct your own routes, using either the preferred resourceful style or the `match` method.

View file

@ -3,6 +3,8 @@ Ruby on Rails Guides Guidelines
This guide documents guidelines for writing Ruby on Rails Guides. This guide follows itself in a graceful loop, serving itself as an example.
After reading this guide, you will know:
--------------------------------------------------------------------------------
Markdown

View file

@ -1,7 +1,9 @@
Ruby On Rails Security Guide
============================
This manual describes common security problems in web applications and how to avoid them with Rails. After reading it, you should be familiar with:
This manual describes common security problems in web applications and how to avoid them with Rails.
After reading this guide, you will know:
* All countermeasures _that are highlighted_.
* The concept of sessions in Rails, what to put in there and popular attack methods.

View file

@ -2,7 +2,9 @@ A Guide to Testing Rails Applications
=====================================
This guide covers built-in mechanisms offered by Rails to test your
application. By referring to this guide, you will be able to:
application.
After reading this guide, you will know:
* Understand Rails testing terminology.
* Write unit, functional, and integration tests for your application.

View file

@ -3,6 +3,8 @@ A Guide for Upgrading Ruby on Rails
This guide provides steps to be followed when you upgrade your applications to a newer version of Ruby on Rails. These steps are also available in individual release guides.
After reading this guide, you will know:
--------------------------------------------------------------------------------
General Advice

View file

@ -3,7 +3,9 @@ Working with JavaScript in Rails
This guide covers the built-in Ajax/JavaScript functionality of Rails (and
more); it will enable you to create rich and dynamic Ajax applications with
ease! We will cover the following topics:
ease!
After reading this guide, you will know:
* Quick introduction to Ajax.
* Unobtrusive JavaScript.