Commit Graph

229 Commits

Author SHA1 Message Date
Rafael Mendonça França
5f5f3a8216 Add link to the show action in the getting started
[ci skip]

Closes #16538
2015-02-06 20:47:39 -02:00
Xavier Noria
cd7cc5254b Remove documentation tasks
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.
2015-02-06 21:04:54 +01:00
Yves Senn
9373ca2808 remove trailing whitespace. [ci skip] 2015-01-25 12:16:32 +01:00
Bryan Bibat
eed34e2251 Add tip for running binstubs on Windows [ci skip]
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.
2015-01-25 14:18:07 +08:00
Yves Senn
b7dc096c99 Merge pull request #18493 from twoller/master
Consistent anchor text in nav links, new image [ci skip]
2015-01-17 14:06:33 +01:00
Toby Woller
3447e76536 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.

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.
2015-01-15 12:24:11 -08:00
Andrey Nering
bf5f038491 Adding tip about jQuery UJS [ci skip]
Reference #18533
2015-01-15 16:22:52 -02:00
Vipul A M
5cfaf5a46e - Changed IN to ON in markdown renderer condition
- Changed `IN` to `ON` in all note sentences in guides.
2015-01-14 11:52:13 +05:30
Robin Dupret
1fd44213aa Remove the tmp/sessions folder and its clear task
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]
2015-01-03 19:42:07 +01:00
Zachary Scott
de1c1a6f7b Revert part of 996e646bd8cff3bcf2b13863439f48d3e744cdae [ci skip] 2015-01-02 12:19:52 -08:00
Lucas Caton
93fb7c76b1 Updating guides for Rails 5.0 [ci skip] 2015-01-02 09:05:59 +10:00
Jennifer Wollesen
0591e852d2 Update Getting Started guide to reflect foreign key in migration [ci skip] 2014-12-30 22:41:54 -07:00
Zachary Scott
996e646bd8 The Guide to Testing Rails Applications is published! 🎉 🎉 [ci skip] 2014-12-30 11:13:20 -08:00
Robin Dupret
ef7e440c97 Fix a few typos [ci skip] 2014-12-24 19:56:00 +01:00
Xavier Noria
7702974281 warn about reading guides in GitHub
References #18148.
2014-12-23 23:32:50 +01:00
Andrey Nering
f57e1a2245 Add link for Domain-Specific Language [ci skip] 2014-12-19 21:16:58 -02:00
Zachary Scott
65faa8f0da Output extension is no longer generated [ci skip]
/cc @senny Is this change documented somewhere?
2014-12-18 16:54:48 -08:00
Zachary Scott
9dbe896840 Remove this tip, if the previous statement is true.. ie: The reader sees "Rails
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.
2014-12-15 19:07:32 -08:00
Zachary Scott
ce03e36f3e Merge pull request #17992 from andreynering/guides-intallation
Improving tips about installation in the guides [ci skip]
2014-12-15 19:06:47 -08:00
Zachary Scott
6b96a1eae1 Add null option to timestamps as migration generator does [ci skip] 2014-12-14 20:42:38 -05:00
Zachary Scott
7607687c91 Fix path typo to Article model in Getting Started [ci skip] 2014-12-14 20:40:13 -05:00
Zachary Scott
67fe22d8f9 Use generic timestamp for generated migration file. [ci skip] 2014-12-14 20:30:58 -05:00
Zachary Scott
81c9aadca4 Edit pass to section 5.1 of getting started guide [ci skip] 2014-12-14 20:05:51 -05:00
Andrey Nering
e46b4c2d7e Improving tips about installation in the guides [ci skip] 2014-12-12 19:39:28 -02:00
Arthur Nogueira Neves
f28d1ddd50 Merge pull request #17705 from fgo/patch-14
Move 'the' outside of SQLite and Bundler link text [ci skip]
2014-11-21 15:21:22 -05:00
Francis Go
27908faf63 Move 'the' outside of SQLite and Bundler link text [ci skip] 2014-11-22 02:37:56 +11:00
Francis Go
e389720ddd Update grammar in Getting Started Guide [ci skip] 2014-11-21 23:36:05 +11:00
Greg Molnar
e950c3e47b add Nokogiri to docs generation guides 2014-11-16 16:38:08 +00:00
Prathamesh Sonpatki
00d14936b0 Mention that articles resource should be added by user in getting started guide
[ci skip]
2014-11-05 00:44:09 +05:30
Mikhail Dieterle
ed7e875154 recount files quantity 2014-08-23 22:13:22 +03:00
Vijay Dev
41231ef6c6 Merge branch 'master' of github.com:rails/docrails
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
2014-08-19 16:28:53 +00:00
Tom Kadwill
4756569718 Removed unnecessary word 2014-08-19 07:48:12 +01:00
Juanito Fatas
bc70448f6d [ci skip] Update links in getting_started guide. 2014-08-16 15:45:36 +08:00
David Heinemeier Hansson
206347fd3e Update docs to reflect that helper stubs are no longer generated 2014-08-03 15:12:05 -07:00
Zachary Scott
cadc8a0dfc Merge pull request #16306 from aditya-kapoor/add-docs-for-uglifier
[ci skip] add tip for uglifier in execjs error
2014-08-02 23:10:34 -07:00
Aditya Kapoor
1f72ab3add [ci skip] add tip for uglifier in execjs error 2014-08-03 10:13:38 +05:30
Vijay Dev
3bf2a4c0d2 Merge branch 'master' of github.com:rails/docrails
Conflicts:
	guides/source/testing.md
2014-08-02 12:09:07 +00:00
Akshay Vishnoi
28b3180f49 Fixes #16255 [ci skip] 2014-07-22 19:19:32 +05:30
Juanito Fatas
132e3fdf80 [ci skip] Normalize all localhost linking. 2014-07-20 18:30:27 +08:00
JayK31
50555f3c98 [ci skip] Fixed link to strong params in Getting Started section 5.6. 2014-07-09 23:00:51 -04:00
Zachary Scott
7a3192e760 Merge pull request #16097 from nishantmodak/correct_md
correct markdown usage [ci skip]
2014-07-08 14:57:44 -07:00
Nishant Modak
da5ac71885 correct markdown usage [ci skip] 2014-07-09 01:32:44 +05:30
Robin Dupret
c2d96d14ec Update Rails versions [ci skip]
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]
2014-07-07 14:22:25 +02:00
Rory O’Kane
13ee4e13b8 Add punctuation and fix capitalization in Getting Started guide
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.
2014-06-28 22:59:04 -04:00
Rory O’Kane
25a4995313 Add missing period in Getting Started guide
Within section 5.10 Adding Some Validation
2014-06-28 01:54:41 -04:00
Timothy Aveni
a4aa95e6af Change double quotes to single quotes in guide
Improve consistency
2014-06-21 21:23:48 -04:00
Yves Senn
5223bad17c docs, remove getting started guide sample application. [ci skip]
This application always gets out of sync and doesn't add much value.

Closes #15721

/cc @rafaelfranca
2014-06-14 16:20:42 +02:00
Aditya Kapoor
f651d352eb Correct Bundler link [ci skip] 2014-06-11 01:45:55 +05:30
Jonathan Powers
d99172e450 Update getting_started.md
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]
2014-06-05 00:26:56 -05:00
Jonathan Powers
4316f2abed Update getting_started.md
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]
2014-06-05 00:25:41 -05:00