[Locomotive-users] Locomotive help instructions suggestions

Michael Potter pottmi at gmail.com
Tue Jan 23 22:19:03 GMT 2007


Here are some suggestions for the Locomotive getting started help page.  Overall
the instructions are great.  These are just some suggestions to make them better.

A) regarding this fragment:
-----------
8. Finally, we'll add a small amount of dynamic content to this page. Open the
hello.rhtml file again and change it to look like this:

Hello
-----------
I think Hello has to be some kind of item that has dynamic content.  All I see
on my screen is Hello.

B) I think it would be helpful to have some kind of overview before the section
on configuring the databases that helps a guy figure out which one to follow. 
For instance, is there a database included in locomotive?  If so it would be
cool to point that out so a person would know that they could use cookbook
instructions to use that database.  If nothing else, one sentence: "You will
need to have a database installed on your machine before locomotive can be fully
useful.  Instructions on installing a database are beyond the scope of this help
page."
 
I had postgres installed on my machine so the lack of this information did not
slow me down, but had it been clear to me that locomotive contained a database I
would have just used that one.         

C) regarding this fragment:
---------------
On the command line in the terminal type:
ruby script/generate scaffold Monkey
          
Navigate to localhost:3000/monkeys
---------------
It would be helpful to have some description on why sometimes one uses the
singular version and sometimes the plural version.  I am sure it makes sense and
is intuitive once one is used to it, but this sample does not have enough
information for me to see the pattern of when to use which.

hats off to the people who build locomotive.  This is the kind of tool that can
make a good product succeed.



More information about the Locomotive-users mailing list