Commit Graph

54 Commits

Author SHA1 Message Date
Gosha Arinich
11f74f08b8 wrap terminal prompt marks in a pre tag 2013-01-05 21:21:20 +03:00
Gosha Arinich
25852593df proper article in the getting started guide 2013-01-05 20:04:40 +03:00
Akira Matsuda
eed9f2539e let's get started with PATCH method rather than PUT 2013-01-03 20:45:45 +09:00
schneems
baea5d69be Use Rails to Render Default Index Page
This is an alternative implementation to #7771 thanks to the advice of @spastorino

Rails is a dynamic framework that serves a static index.html by default. One of my first questions ever on IRC was solved by simply deleting my public/index.html file. This file is a source of confusion when starting as it over-rides any set "root" in the routes yet it itself is not listed in the routes. By making the page dynamic by default we can eliminate this confusion.

This PR moves the static index page to an internal controller/route/view similar to `rails/info`. When someone starts a rails server, if no root is defined, this route will take over and the "dynamic" index page from rails/welcome_controller will be rendered. These routes are only added in development. If a developer defines a root in their routes, it automatically takes precedence over this route and will be rendered, with no deleting of files required. 

In addition to removing this source of confusion for new devs, we can now use Rails view helpers to build and render this page. While not the primary intent, the added value of "dogfooding" should not be under-estimated.

The prior PR #7771 had push-back since it introduced developer facing files. This PR solves all of the same problems, but does not have any new developer facing files (it actually removes one). 

cc/ @wsouto, @dickeyxxx, @tyre, @ryanb, @josevalim, @maxim, @subdigital, @steveklabnik

ATP Railties and Actionpack.
2012-12-10 16:15:04 -08:00
Vijay Dev
4085dd6010 Revert "Introduce Bundler and Gemfiles in a NOTE"
This reverts commit 83cb6fbd13f3c5ea3106b9a57964b1a6fb243682.

Reason: very trivial

[ci skip]
2012-12-08 23:02:52 +05:30
Katie Oldaker
7c05ea23a0 Fixed grammar in a lot of guide prologues. 2012-12-07 12:50:09 -05:00
Pablo Torres
83cb6fbd13 Introduce Bundler and Gemfiles in a NOTE 2012-12-05 21:39:58 -05:00
Pablo Torres
cb389fc6d0 Define a generator before referring to it 2012-12-04 21:38:06 -05:00
Pablo Torres
ad223520bf Correct bad English 2012-12-04 21:10:54 -05:00
Yoni Yalovitsky
57c60d36d3 added full file path in all file references
It's really comfy being able to copy-paste the file paths.

I suppose there's also some benefit in trying to figure out the file name as a small exercise, but I don't think that sort of thing belongs in "Getting Started".
2012-12-03 03:11:16 +02:00
Yoni Yalovitsky
ef4e8352fe removed an extra slash before the 'app' dir 2012-12-03 02:57:40 +02:00
Steve Klabnik
d16a1b9e8b 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.
2012-11-29 14:25:02 -08:00
Steve Klabnik
5ea8a41cdd Remove 'This guide is based on ' warnings.
It's obvious that the guide is based on this version of Rails, and may not be backwards compatible.
2012-11-29 05:21:30 -08:00
Steve Klabnik
28e8abfa59 Getting Started: Improve instructions on opening a terminal 2012-11-29 04:10:03 -08:00
Steve Klabnik
e8b26258d0 Getting Started: remove reference to attr_accessible 2012-11-29 04:06:08 -08:00
Steve Klabnik
8bc945da5f Getting Started: mac -> Mac OS X
It's properly called "Mac OS X"
2012-11-29 04:05:54 -08:00
Steve Klabnik
213f034059 Getting Started: Rails 3.2 -> Rails 4.
This is based on Rails 4, not Rails 3.2.
2012-11-29 03:53:58 -08:00
Hendy Tanata
8f43c9afc4 Set fixed-width style where appropriate on Getting Started guide. 2012-11-27 16:24:22 +08:00
Jason Noble
064ae350dc Revert "Updated with where functional/helper tests go"
This reverts commit c94cfdad6388dcdfaf4c10b9e8cee46baf2a7901.

* This is the new 4.0 (master) directory structure
2012-11-25 12:02:01 -07:00
Jason Noble
f9793a121e Reword Post model to note there are lines not shown 2012-11-24 22:57:21 -07:00
Jason Noble
45f0fead7a We should use post_path, not post_url 2012-11-24 22:56:56 -07:00
Jason Noble
c94cfdad63 Updated with where functional/helper tests go 2012-11-24 22:41:30 -07:00
Jason Noble
9314867b1f Moved position of has_many 2012-11-24 22:37:50 -07:00
Jason Noble
3e8c4bc6c6 Added new line to make it more readable
* This shows the reader there is a method: and 
  data: parameters
2012-11-24 22:25:32 -07:00
Jason Noble
a22fc4abf1 Changed the Using Partials section to read a little better
* No need to give a simple example, as we have a
  partial that we create in the blog app
2012-11-24 22:24:29 -07:00
Jason Noble
85db49fd8d Modified "Allowing the update of fields" section
* Rails generate model Post ______ creates the
  attr_accessible line for you for any fields
  you specify. Changed the section to describe
  what this line in the model does.
2012-11-24 21:37:53 -07:00
Jason Noble
c332393f75 Update version numbers of Ruby and Rails 2012-11-24 21:02:48 -07:00
Jason Noble
65ee3d76b3 Updated link to RubyGems site 2012-11-24 18:27:10 -07:00
burningTyger
8dabfbebdb use em-dashes instead of two minuses in guides 2012-11-10 23:00:00 +01:00
Rafael Mendonça França
9eeb00976d Revert "divided into folder with the language"
This reverts commit f5b9ed4fbc3215a5fce48985ea372ad3f1182252.

REASON: Translation work can not be done in the docrails repository
2012-10-17 10:15:55 -03:00
Rodrigo Martins
f5b9ed4fbc divided into folder with the language 2012-10-17 03:34:10 -03:00
Jaime Iniesta
3e0be3ab5e Fix typos and clean up Getting Started guide 2012-10-12 23:44:39 +02:00
Tim McEwan
8cf428fe78 specify path to CommentsController again inline
(incorporating feedback from a newbie)
2012-10-12 22:18:49 +11:00
AvnerCohen
61c64dc942 1.9 hash syntax for guides, work-in-progress 2012-10-11 16:38:31 +02:00
Vijay Dev
f638ef951b Merge branch 'master' of github.com:lifo/docrails
Conflicts:
	activerecord/lib/active_record/persistence.rb
	railties/lib/rails/generators/rails/resource_route/resource_route_generator.rb
2012-10-11 01:05:14 +05:30
Mike Moore
2a68f68aea Update test locations
Change the default test locations to avoid confusion around the common
testing terms "unit" and "functional".
Add new rake tasks for the new locations, while maintaining backwards
compatibility with the old rake tasks.

New testing locations are as follows:

    app/models -> test/models (was test/units)
    app/helpers -> test/helpers (was test/units/helpers)
    app/controllers -> test/controllers (was test/functional)
    app/mailers -> test/mailers (was test/functional)
2012-10-09 17:53:56 -06:00
schneems
ddcda853c1 Add /rails/info/routes method to getting_started
Also fix # to $ for `rake routes` command
2012-10-02 11:31:23 -04:00
schneems
e427c3becf explain how to check if the server has returned on *nix systems in getting_started guide 2012-10-02 11:31:23 -04:00
schneems
f8a54e16a9 Explain that command line commands have $
This was extremely confusing to new programmers, also different operating systems call the command line something different
2012-10-02 11:31:23 -04:00
schneems
6b1467b848 change # to $ in bash section 2012-10-02 11:31:23 -04:00
Francesco Rodriguez
76ea63c8bb use <url> markdown syntax instead of [url](url) [ci skip] 2012-10-01 14:31:23 -05:00
Vijay Dev
25c3c89e97 fix some md syntax errors and general revisions [ci skip] 2012-09-21 23:34:36 +05:30
Vijay Dev
3b7947ea31 Merge branch 'master' of github.com:lifo/docrails
Conflicts:
	actionmailer/lib/action_mailer/base.rb
	activesupport/lib/active_support/configurable.rb
	activesupport/lib/active_support/core_ext/module/deprecation.rb
	guides/source/action_controller_overview.md
	guides/source/active_support_core_extensions.md
	guides/source/ajax_on_rails.textile
	guides/source/association_basics.textile
	guides/source/upgrading_ruby_on_rails.md

While resolving conflicts, I have chosen to ignore changes done in
docrails at some places - these will be most likely 1.9 hash syntax
changes.
2012-09-21 22:49:20 +05:30
Prem Sichanugrist
41dbb58e2d Fix the usage of * in Markdown
In Textile `*` would convert to `<strong>`, but in Markdown we have to
use `**` instead.
2012-09-17 15:54:23 -04:00
Prem Sichanugrist
721afdcc4b Fix remaining formatting problems in the guide 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
2e89ac34cf Convert image tags to Markdown syntax 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
2c38567646 Convert all tables to Markdown syntax 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
9873dd800b Convert all the links into Markdown format 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
31ef4cf656 Convert all inline codes to Markdown syntax 2012-09-17 15:54:23 -04:00
Prem Sichanugrist
21a0b20e39 change shell to bash 2012-09-17 15:54:22 -04:00