Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Ticket #8770 (closed enhancement: fixed)

Opened 1 year ago

Last modified 11 months ago

[PATCH] Update to the debug section of the top level api README

Reported by: mikel Assigned to: core
Priority: normal Milestone: 2.x
Component: Railties Version: edge
Severity: normal Keywords: docs
Cc:

Description

When I was learning rails, I had to look in many different locations to figure out how to do some basic things like logging and other debugging tasks.

I have done a short update to the debug section of the top level README to introduce people more completely to the options they have on debugging rails.

It is not information overload, but makes the process a bit clearer and also explains how to add your own log message from a controller.

It also points out that Ruby on Rails is based on Ruby and for new people to go look at the two online Ruby books to learn more about the language they are trying to debug themselves.

Attachments

update_to_debug_section_on_front_readme (2.5 kB) - added by mikel on 06/27/07 12:15:16.
Update to the top level README
update_to_debug_section_on_front_readme.diff (2.2 kB) - added by mikel on 10/08/07 03:45:51.
Updated text to make it read better
1-2-stable_update_to_debug_section_on_front_readme.diff (1.9 kB) - added by mikel on 10/08/07 04:26:36.
This doc patch updated and applied to 1.2 stable
trunk_update_to_debug_section_on_front_readme.diff (2.3 kB) - added by mikel on 10/08/07 04:27:22.
This doc patch updated and applied to Trunk

Change History

06/27/07 12:15:16 changed by mikel

  • attachment update_to_debug_section_on_front_readme added.

Update to the top level README

06/28/07 05:23:47 changed by mikel

  • keywords changed from doc to docs.
  • version changed from edge to 1.2.3.

06/28/07 05:30:18 changed by mikel

  • version changed from 1.2.3 to edge.

10/08/07 03:44:29 changed by mikel

Updated text to reduce the lecturing style and make it more focused on people with a clue :)

10/08/07 03:45:51 changed by mikel

  • attachment update_to_debug_section_on_front_readme.diff added.

Updated text to make it read better

10/08/07 04:26:36 changed by mikel

  • attachment 1-2-stable_update_to_debug_section_on_front_readme.diff added.

This doc patch updated and applied to 1.2 stable

10/08/07 04:27:22 changed by mikel

  • attachment trunk_update_to_debug_section_on_front_readme.diff added.

This doc patch updated and applied to Trunk

10/08/07 04:29:10 changed by mikel

OK... two new files.

trunk_update_to_debug_section_on_front_readme.diff applies cleanly to trunk

1-2-stable_update_to_debug_section_on_front_readme.diff applies cleanly to 1.2 stable

Mikel

10/08/07 05:32:53 changed by nzkoz

(In [7796]) Improve README documentation. References #8770 [mikel]

10/08/07 05:36:07 changed by nzkoz

  • status changed from new to closed.
  • resolution set to fixed.

(In [7797]) Improve README documentation. Closes #8770 [mikel]