Skip to content

Commit

Permalink
Docfixes (closes #7348, #7778, #8669)
Browse files Browse the repository at this point in the history
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7102 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information
dhh committed Jun 23, 2007
1 parent b0391d1 commit 3ae2bf0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
15 changes: 6 additions & 9 deletions railties/README
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Rails. You can read more about Action Pack in
link:files/vendor/rails/actionpack/README.html. link:files/vendor/rails/actionpack/README.html.




== Getting started == Getting Started


1. At the command prompt, start a new rails application using the rails command 1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
and your application name. Ex: rails myapp and your application name. Ex: rails myapp
(If you've downloaded rails in a complete tgz or zip, this step is already done) (If you've downloaded Rails in a complete tgz or zip, this step is already done)
2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options) 2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!" 3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
4. Follow the guidelines to start developing your application 4. Follow the guidelines to start developing your application
Expand All @@ -38,11 +38,11 @@ link:files/vendor/rails/actionpack/README.html.
== Web Servers == Web Servers


By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
Rails will use the WEBrick, the webserver that ships with Ruby. When you run script/server, Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
that you can always get up and running quickly. that you can always get up and running quickly.


Mongrel is a Ruby-based webserver with a C-component (which requires compilation) that is Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
suitable for development and deployment of Rails applications. If you have Ruby Gems installed, suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>. getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
More info at: http://mongrel.rubyforge.org More info at: http://mongrel.rubyforge.org
Expand Down Expand Up @@ -111,11 +111,8 @@ Passing an argument will specify a different environment, like <tt>script/consol


To reload your controllers and models after launching the console run <tt>reload!</tt> To reload your controllers and models after launching the console run <tt>reload!</tt>


To reload your controllers and models after launching the console run <tt>reload!</tt>




== Description of contents == Description of Contents


app app
Holds all the code that's specific to this particular application. Holds all the code that's specific to this particular application.
Expand Down
2 changes: 1 addition & 1 deletion railties/doc/README_FOR_APP
Original file line number Original file line Diff line number Diff line change
@@ -1,2 +1,2 @@
Use this README file to introduce your application and point to useful places in the API for learning more. Use this README file to introduce your application and point to useful places in the API for learning more.
Run "rake appdoc" to generate API documentation for your models and controllers. Run "rake doc:app" to generate API documentation for your models and controllers.
2 changes: 1 addition & 1 deletion railties/lib/tasks/documentation.rake
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ namespace :doc do


plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) } plugins = FileList['vendor/plugins/**'].collect { |plugin| File.basename(plugin) }


desc "Generate documation for all installed plugins" desc "Generate documentation for all installed plugins"
task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" } task :plugins => plugins.collect { |plugin| "doc:plugins:#{plugin}" }


desc "Remove plugin documentation" desc "Remove plugin documentation"
Expand Down

0 comments on commit 3ae2bf0

Please sign in to comment.