documents.yaml 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. -
  2. name: Start Here
  3. documents:
  4. -
  5. name: Getting Started with Rails
  6. url: getting_started.html
  7. description: Everything you need to know to install Rails and create your first application.
  8. -
  9. name: Models
  10. documents:
  11. -
  12. name: Rails Database Migrations
  13. url: migrations.html
  14. description: This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
  15. -
  16. name: Active Record Validations and Callbacks
  17. url: active_record_validations_callbacks.html
  18. description: This guide covers how you can use Active Record validations and callbacks.
  19. -
  20. name: Active Record Associations
  21. url: association_basics.html
  22. description: This guide covers all the associations provided by Active Record.
  23. -
  24. name: Active Record Query Interface
  25. url: active_record_querying.html
  26. description: This guide covers the database query interface provided by Active Record.
  27. -
  28. name: Views
  29. documents:
  30. -
  31. name: Layouts and Rendering in Rails
  32. url: layouts_and_rendering.html
  33. description: 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.
  34. -
  35. name: Action View Form Helpers
  36. url: form_helpers.html
  37. description: Guide to using built-in Form helpers.
  38. -
  39. name: Controllers
  40. documents:
  41. -
  42. name: Action Controller Overview
  43. url: action_controller_overview.html
  44. description: 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.
  45. -
  46. name: Rails Routing from the Outside In
  47. url: routing.html
  48. description: 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.
  49. -
  50. name: Digging Deeper
  51. documents:
  52. -
  53. name: Active Support Core Extensions
  54. url: active_support_core_extensions.html
  55. description: This guide documents the Ruby core extensions defined in Active Support.
  56. -
  57. name: Rails Internationalization API
  58. url: i18n.html
  59. description: This guide covers how to add internationalization to your applications. Your application will be able to translate content to different languages, change pluralization rules, use correct date formats for each country and so on.
  60. -
  61. name: Action Mailer Basics
  62. url: action_mailer_basics.html
  63. work_in_progress: true
  64. description: This guide describes how to use Action Mailer to send and receive emails.
  65. -
  66. name: Testing Rails Applications
  67. url: testing.html
  68. work_in_progress: true
  69. description: 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. Enjoy.
  70. -
  71. name: Securing Rails Applications
  72. url: security.html
  73. description: This guide describes common security problems in web applications and how to avoid them with Rails.
  74. -
  75. name: Debugging Rails Applications
  76. url: debugging_rails_applications.html
  77. description: 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.
  78. -
  79. name: Performance Testing Rails Applications
  80. url: performance_testing.html
  81. description: This guide covers the various ways of performance testing a Ruby on Rails application.
  82. -
  83. name: Configuring Rails Applications
  84. url: configuring.html
  85. description: This guide covers the basic configuration settings for a Rails application.
  86. -
  87. name: Rails Command Line Tools and Rake Tasks
  88. url: command_line.html
  89. description: This guide covers the command line tools and rake tasks provided by Rails.
  90. -
  91. name: Caching with Rails
  92. work_in_progress: true
  93. url: caching_with_rails.html
  94. description: Various caching techniques provided by Rails.
  95. -
  96. name: Asset Pipeline
  97. url: asset_pipeline.html
  98. description: This guide documents the asset pipeline.
  99. -
  100. name: The Rails Initialization Process
  101. work_in_progress: true
  102. url: initialization.html
  103. description: This guide explains the internals of the Rails initialization process as of Rails 3.1
  104. -
  105. name: Extending Rails
  106. documents:
  107. -
  108. name: The Basics of Creating Rails Plugins
  109. work_in_progress: true
  110. url: plugins.html
  111. description: This guide covers how to build a plugin to extend the functionality of Rails.
  112. -
  113. name: Rails on Rack
  114. url: rails_on_rack.html
  115. description: This guide covers Rails integration with Rack and interfacing with other Rack components.
  116. -
  117. name: Creating and Customizing Rails Generators
  118. url: generators.html
  119. description: This guide covers the process of adding a brand new generator to your extension or providing an alternative to an element of a built-in Rails generator (such as providing alternative test stubs for the scaffold generator).
  120. -
  121. name: Contributing to Ruby on Rails
  122. documents:
  123. -
  124. name: Contributing to Ruby on Rails
  125. url: contributing_to_ruby_on_rails.html
  126. description: Rails is not 'somebody else's framework.' This guide covers a variety of ways that you can get involved in the ongoing development of Rails.
  127. -
  128. name: API Documentation Guidelines
  129. url: api_documentation_guidelines.html
  130. description: This guide documents the Ruby on Rails API documentation guidelines.
  131. -
  132. name: Ruby on Rails Guides Guidelines
  133. url: ruby_on_rails_guides_guidelines.html
  134. description: This guide documents the Ruby on Rails guides guidelines.
  135. -
  136. name: Release Notes
  137. documents:
  138. -
  139. name: Ruby on Rails 3.2 Release Notes
  140. url: 3_2_release_notes.html
  141. description: Release notes for Rails 3.2.
  142. -
  143. name: Ruby on Rails 3.1 Release Notes
  144. url: 3_1_release_notes.html
  145. description: Release notes for Rails 3.1.
  146. -
  147. name: Ruby on Rails 3.0 Release Notes
  148. url: 3_0_release_notes.html
  149. description: Release notes for Rails 3.0.
  150. -
  151. name: Ruby on Rails 2.3 Release Notes
  152. url: 2_3_release_notes.html
  153. description: Release notes for Rails 2.3.
  154. -
  155. name: Ruby on Rails 2.2 Release Notes
  156. url: 2_2_release_notes.html
  157. description: Release notes for Rails 2.2.