aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/getting_started.md
Commit message (Collapse)AuthorAgeFilesLines
* Add link to the show action in the getting startedRafael Mendonça França2015-02-061-0/+1
| | | | | | [ci skip] Closes #16538
* Remove documentation tasksXavier Noria2015-02-061-13/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch removes the tasks doc:app, doc:rails, and doc:guides. In our experience applications do not generate APIs using doc:app. Methods may be certainly documented for maintainers, annotated with YARD tags, etc. but that is intended to be read with the source code, not in a separate website. Then, teams also have typically selected topics written down in Markdown files, or in a GitHub wiki... that kind of thing. If a team absolutely needs to generate application documentation for internal purposes, they can still easily write their own task. Regarding doc:rails and doc:guides, we live in 2015. We are used to go to online docs all the time. If you really want access to the API offline RubyGems generates it for every Rails component unless you tell it not to, and you can checkout the Rails source code to read the guides as Markdown, or download them for a Kindle reader. All in all, maintaining this code does not seem to be worthwhile anymore. As a consequence of this, guides (+3 MB uncompressed) won't be distributed with the rails gem anymore. Of course, guides and API are going to be still part of releases, since documentation is maintained alongside code and tests. Also, time permitting, this will allow us to experiment with novel ways to generate documentation in the Rails docs server, since right now we were constrained by being able to generate them in the user's environment.
* remove trailing whitespace. [ci skip]Yves Senn2015-01-251-1/+1
|
* Add tip for running binstubs on Windows [ci skip]Bryan Bibat2015-01-251-0/+3
| | | | | | | The default command prompt under Windows doesn't run binstubs correctly while PowerShell needs to find the location of the Ruby interpreter for it to work properly. Passing the binstubs manually to the interpreter solves this problem.
* Merge pull request #18493 from twoller/masterYves Senn2015-01-171-10/+10
|\ | | | | Consistent anchor text in nav links, new image [ci skip]
| * Use consistent anchor text throughout the guide.Toby Woller2015-01-151-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | Change all of anchor text in the nav links to `Back` and `Edit` Use `Edit | Back` on pages that use both links to conform to what scaffolding generates. Use consistent anchor text throughout the guide. Change all of anchor text in the nav links to `Back` and `Edit` Use `Edit | Back` on pages that use both links to conform to what scaffolding generates.
* | Adding tip about jQuery UJS [ci skip]Andrey Nering2015-01-151-0/+3
| | | | | | | | Reference #18533
* | - Changed `IN` to `ON` in markdown renderer conditionVipul A M2015-01-141-1/+1
|/ | | | - Changed `IN` to `ON` in all note sentences in guides.
* Remove the tmp/sessions folder and its clear taskRobin Dupret2015-01-031-1/+1
| | | | | | | | | | Commit 1aea470 introduced this directory but this was at a time when the default way to store sessions was on the file system under the tmp directory. Let's remove references to it from the documentation as well. [Robin Dupret & yui-knk]
* Revert part of 996e646bd8cff3bcf2b13863439f48d3e744cdae [ci skip]Zachary Scott2015-01-021-3/+0
|
* Updating guides for Rails 5.0 [ci skip]Lucas Caton2015-01-021-1/+1
|
* Update Getting Started guide to reflect foreign key in migration [ci skip]Jennifer Wollesen2014-12-301-0/+3
|
* The Guide to Testing Rails Applications is published! :tada: :tada: [ci skip]Zachary Scott2014-12-301-3/+8
|
* Fix a few typos [ci skip]Robin Dupret2014-12-241-1/+1
|
* warn about reading guides in GitHubXavier Noria2014-12-231-0/+2
| | | | References #18148.
* Add link for Domain-Specific Language [ci skip]Andrey Nering2014-12-191-2/+3
|
* Output extension is no longer generated [ci skip]Zachary Scott2014-12-181-4/+4
| | | | /cc @senny Is this change documented somewhere?
* Remove this tip, if the previous statement is true.. ie: The reader sees "RailsZachary Scott2014-12-151-5/+0
| | | | | | 4.2.0", then they should have no problems hacking with Rails. [ci skip] If they do, then its a bug and it should be reported.
* Merge pull request #17992 from andreynering/guides-intallationZachary Scott2014-12-151-6/+11
|\ | | | | Improving tips about installation in the guides [ci skip]
| * Improving tips about installation in the guides [ci skip]Andrey Nering2014-12-121-6/+11
| |
* | Add `null` option to timestamps as migration generator does [ci skip]Zachary Scott2014-12-141-2/+2
| |
* | Fix path typo to Article model in Getting Started [ci skip]Zachary Scott2014-12-141-1/+1
| |
* | Use generic timestamp for generated migration file. [ci skip]Zachary Scott2014-12-141-2/+2
| |
* | Edit pass to section 5.1 of getting started guide [ci skip]Zachary Scott2014-12-141-15/+17
|/
* Merge pull request #17705 from fgo/patch-14Arthur Nogueira Neves2014-11-211-2/+2
|\ | | | | Move 'the' outside of SQLite and Bundler link text [ci skip]
| * Move 'the' outside of SQLite and Bundler link text [ci skip]Francis Go2014-11-221-2/+2
| |
* | Update grammar in Getting Started Guide [ci skip]Francis Go2014-11-211-2/+2
|/
* add Nokogiri to docs generation guidesGreg Molnar2014-11-161-1/+1
|
* Mention that articles resource should be added by user in getting started guidePrathamesh Sonpatki2014-11-051-4/+4
| | | | [ci skip]
* recount files quantityMikhail Dieterle2014-08-231-1/+1
|
* Merge branch 'master' of github.com:rails/docrailsVijay Dev2014-08-191-5/+5
|\ | | | | | | | | | | | | Conflicts: actionpack/lib/action_controller/metal/mime_responds.rb actionview/lib/action_view/vendor/html-scanner/html/sanitizer.rb activerecord/lib/active_record/type/value.rb
| * [ci skip] Update links in getting_started guide.Juanito Fatas2014-08-161-5/+5
| |
* | Removed unnecessary wordTom Kadwill2014-08-191-1/+1
| |
* | Update docs to reflect that helper stubs are no longer generatedDavid Heinemeier Hansson2014-08-031-3/+0
| |
* | Merge pull request #16306 from aditya-kapoor/add-docs-for-uglifierZachary Scott2014-08-021-8/+9
|\ \ | |/ |/| [ci skip] add tip for uglifier in execjs error
| * [ci skip] add tip for uglifier in execjs errorAditya Kapoor2014-08-031-8/+9
| |
* | Merge branch 'master' of github.com:rails/docrailsVijay Dev2014-08-021-2/+2
|\ \ | |/ |/| | | | | Conflicts: guides/source/testing.md
| * [ci skip] Normalize all localhost linking.Juanito Fatas2014-07-201-2/+2
| |
* | Fixes #16255 [ci skip]Akshay Vishnoi2014-07-221-1/+1
|/
* [ci skip] Fixed link to strong params in Getting Started section 5.6.JayK312014-07-091-2/+1
|
* Merge pull request #16097 from nishantmodak/correct_mdZachary Scott2014-07-081-5/+3
|\ | | | | correct markdown usage [ci skip]
| * correct markdown usage [ci skip]Nishant Modak2014-07-091-5/+3
| |
* | Update Rails versions [ci skip]Robin Dupret2014-07-071-1/+1
|/ | | | | | | | | | | | | As discussed in #15304, we need to automate this process but for now, having out-of-date versions is not ideal. Since master targets 4.2.0, let's also update references to the last 4.1 version to 4.2.0. Finally, let's remove mentions to versions when this is not needed. The guides cover the features of the current version anyway. [Juanito Fatas + Robin Dupret]
* Add punctuation and fix capitalization in Getting Started guideRory O’Kane2014-06-281-3/+3
| | | | | | | | | | | | Fix more small grammar mistakes in the [Getting Started guide](http://edgeguides.rubyonrails.org/getting_started.html#security), in sections 9 and 10. Specifically, within sections 9.1 “Basic Authentication”, 9.2 “Other Security Considerations”, and 10 “What's Next?”. “Rails Guides” is generally capitalized on the site, including on the linked page and in the title of the site, so I capitalized it. “The” is not part of the name of the Ruby on Rails Security Guide – “The” is not in the title on that page. And I added a missing period and a missing colon at the ends of two sentences.
* Add missing period in Getting Started guideRory O’Kane2014-06-281-1/+1
| | | | Within section 5.10 Adding Some Validation
* Change double quotes to single quotes in guideTimothy Aveni2014-06-211-1/+1
| | | | Improve consistency
* docs, remove getting started guide sample application. [ci skip]Yves Senn2014-06-141-3/+2
| | | | | | | | This application always gets out of sync and doesn't add much value. Closes #15721 /cc @rafaelfranca
* Correct Bundler link [ci skip]Aditya Kapoor2014-06-111-4/+3
|
* Update getting_started.mdJonathan Powers2014-06-051-0/+2
| | | It's not very clear exactly what the "params" method is and does, as the current description in the guide is somewhat vague and brief. An example is helpful, especially considering this method is referenced over 30 times in this guide. [ci skip]
* Update getting_started.mdJonathan Powers2014-06-051-0/+2
| | | It may be confusing to a Rails newbie why "Article" is suddenly being referred to with the "A" being capitalized. Thus far in the guide, the "a" has always been in lowercase. I think it is helpful to point out the reason for this change (especially since not using the capital "A" will result in an error). [ci skip]