Skip to content

Commit

Permalink
Rework of Guides index page
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Gunderloy authored and Mike Gunderloy committed Sep 30, 2008
1 parent e8ab3c0 commit 97b6383
Showing 1 changed file with 55 additions and 38 deletions.
93 changes: 55 additions & 38 deletions railties/doc/guides/index.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,85 +3,91 @@ Ruby on Rails guides

WARNING: This page is the result of ongoing http://hackfest.rubyonrails.org/guide[Rails Guides hackfest] and a work in progress.

CAUTION: Guides marked with this icon are currently being worked on. While they might still be useful to you, they may contain incomplete information and even errors. You can help by reviewing them and posting your comments and corrections at the respective Lighthouse ticket.

++++++++++++++++++++++++++++++++++++++
<h2>Finished Guides</h2>
<h2>Start Here</h2>
++++++++++++++++++++++++++++++++++++++

These guides are complete and the authors are listed link:authors.html[here].
.link:getting_started_with_rails/getting_started_with_rails.html[Getting Started with Rails]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/2[Lighthouse Ticket]

Everything you need to know to install Rails and create your first application.
***********************************************************

++++++++++++++++++++++++++++++++++++++
<h2>Models</h2>
++++++++++++++++++++++++++++++++++++++

.link:migrations/migrations.html[Rails Database Migrations]
***********************************************************
This guide covers how you can use Active Record migrations to alter your database in a structured and organised manner.
This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
***********************************************************

.link:activerecord/association_basics.html[Active Record Associations]
***********************************************************
This guide covers all the associations provided by Active Record.
***********************************************************

.link:routing/routing_outside_in.html[Rails Routing from the Outside In]
.link:activerecord/finders.html[Active Record Finders]
***********************************************************
This guide covers the user-facing features of Rails routing. If you want to
understand how to use routing in your own Rails applications, start here.
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/16[Lighthouse Ticket]

This guide covers the find method defined in ActiveRecord::Base, as well as named scopes.
***********************************************************

++++++++++++++++++++++++++++++++++++++
<h2>Guides in progress</h2>
<h2>Views</h2>
++++++++++++++++++++++++++++++++++++++

These guides are currently being worked on. While they still might be useful to you, you could always help by reviewing them and posting your
findings at the respective Lighthouse ticket.

.link:actionview/layouts_and_rendering.html[Layouts and Rendering in Rails]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/15[Lighthouse Ticket]
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/15[Lighthouse Ticket]

This guide covers the basic layout features of Action Controller and Action View,
including rendering and redirecting, using +content_for_ blocks, and working
with partials.
***********************************************************

.link:debugging/debugging_rails_applications.html[Debugging Rails Applications]
.link:forms/form_helpers.html[Action View Form Helpers]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/5[Lighthouse Ticket]
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/1[Lighthouse Ticket]

This guide describes how to debug Rails applications. It covers the different
ways of achieving this and how to understand what is happening "behind the scenes"
of your code.
Guide to using built in Form helpers.
***********************************************************

.link:getting_started_with_rails/getting_started_with_rails.html[Getting Started with Rails]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/2[Lighthouse Ticket]
***********************************************************
++++++++++++++++++++++++++++++++++++++
<h2>Controllers</h2>
++++++++++++++++++++++++++++++++++++++

.link:actioncontroller/actioncontroller.html[Basics of Action Controller]
.link:routing/routing_outside_in.html[Rails Routing from the Outside In]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/17[Lighthouse Ticket]
This guide covers the user-facing features of Rails routing. If you want to
understand how to use routing in your own Rails applications, start here.
***********************************************************

.link:activerecord/finders.html[Active Record Finders]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/16[Lighthouse Ticket]
.link:actioncontroller/actioncontroller.html[Basics of Action Controller]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/17[Lighthouse Ticket]

.link:forms/form_helpers.html[Action View Form Helpers]
This guide covers how controllers work and how they fit into the request cycle in your application. It includes sessions, filters, and cookies, data streaming, and dealing with exceptions raised by a request, among other topics.
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/1[Lighthouse Ticket]

Guide to using built in Form helpers.
.link:caching/caching_with_rails.html[Rails Caching]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/10[Lighthouse Ticket]

.link:benchmarking_and_profiling/preamble.html[Benchmarking and Profiling Rails Applications]
This guide covers the three types of caching that Rails provides by default.
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/4[Lighthouse Ticket]

TODO: Insert some description here.
***********************************************************
++++++++++++++++++++++++++++++++++++++
<h2>Digging Deeper</h2>
++++++++++++++++++++++++++++++++++++++

.link:testing_rails_applications/testing_rails_applications.html[Testing Rails Applications]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/8[Lighthouse Ticket]
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/8[Lighthouse Ticket]

This is a rather comprehensive guide to doing both unit and functional tests
in Rails. It covers everything from ``What is a test?'' to the testing APIs.
Expand All @@ -90,20 +96,31 @@ Enjoy.

.link:securing_rails_applications/security.html[Securing Rails Applications]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/7[Lighthouse Ticket]
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/7[Lighthouse Ticket]

This manual describes common security problems in web applications and how to
avoid them with Rails.
***********************************************************

.link:caching/caching_with_rails.html[Rails Caching]
.link:debugging/debugging_rails_applications.html[Debugging Rails Applications]
***********************************************************
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/5[Lighthouse Ticket]

This guide describes how to debug Rails applications. It covers the different
ways of achieving this and how to understand what is happening "behind the scenes"
of your code.
***********************************************************

.link:benchmarking_and_profiling/preamble.html[Benchmarking and Profiling Rails Applications]
***********************************************************
link:http://rails.lighthouseapp.com/projects/16213/tickets/10[Lighthouse Ticket]
CAUTION: link:http://rails.lighthouseapp.com/projects/16213/tickets/4[Lighthouse Ticket]

TODO: Insert some description here.
This guide covers ways to analyze and optimize your running Rails code.
***********************************************************

.link:creating_plugins/creating_plugins.html[The Basics of Creating Rails Plugins]
***********************************************************
TODO: Insert some description here. No Lighthouse ticket.
This guide covers how to build a plugin to extend the functionality of Rails.
***********************************************************

Authors who have contributed to complete guides are listed link:authors.html[here].

0 comments on commit 97b6383

Please sign in to comment.