Online Reference for Ruby on Rails
There are few programmers (especially beginners) who are able to keep in mind the names of all the necessary methods, as well as the number, order and purpose of the parameters passed to them. For this there are reference books on API.
In this post, I would like to bring together a few useful, dedicated to Ruby on Rails, reference resources (including the API) that are always convenient to keep on hand, in the next browser tab.
It will be about:
')
This is most likely the first online Ruby on Rails API reference book that will catch the eye of a novice RoR programmer. The user will not find anything special here - this is the official documentation, so it looks like a pure_rdoc_generated frame -based website. Navigating to C grade - you have to perform the search with a "dictionary in hand", because no built-in search.
It is recommended to get used to http://www.ruby-doc.org , the official documentation for Ruby :-)
Resource other specificity than official API documentation. Here are presented, first of all, various articles, guides and FAQ on setting up, as well as various lists ( communities , hosting , etc.) are collected and introductory descriptions of work with this or that module are provided with brief code examples.
In general, the resource causes very contradictory feelings - on the one hand it is located on the official subdomain, on the other - in fact it turns out that there are very few articles, many of which are in a stub state, while others have long since lost their relevance. First of all, it is of interest as a collection of instructions for configuring and deploying an application, setting up communication with the database and installing plug-ins.
This resource is a collection of articles. It is closer to programming than wiki.rubyonrails.org . Here, in detail and with examples, there are large articles covering all aspects of using the framework: routing, rendering; comprehensively reviewed work with models and controllers. Each article is richly supplied with transparent examples. Among the maintainers of the project is Pratik Naik, which is part of the Rails Core Team.
Being a regular on stackoverflow.com , at first, I was repeatedly sent to read an article on a topic that interests me.
Personal favorite. On the site there is super-convenient navigation with search and a pleasant interface. Implemented on the basis of frames with a small use of JavaScript'a. The directory itself seems to be generated based on official documentation directly from the RoR sources. And although, in theory, it is only a decorated copy of the official version, the inscription on the main one (
Search by methods is performed not only full-text (the search engine is not too lazy to search, including somewhere in the middle of the name), but the so-called smart search: for example, at the request of round , among other things, the method p r oxy_f ound will be found (which is of course good, but it is not clear when this may be necessary).
Pleasant, ascetic design does not distract from searching and reading information. The speed of work is also good - the delay in loading a new page is almost imperceptible (on channel 512 Kb).
The younger brother railsapi.com - railsbrain.com is also present on the Internet . In this review, he did not get the sight of the fact that in addition to the ajax-wrapper (in fact, only search) over off. documentation, it is no longer remarkable.
Generated based on official documentation. For each individual article in the directory, you can write a note (which, in fact, the users registered there do). Notes usually contain various undocumented techniques for using the methods described in the article. Also, each article is assigned a special character by which the documentation of the class or module under consideration is determined. In addition, each article has a timeline version of Rails, which can be used to determine how the article has changed from version to version.
Using the directory in everyday mode seems rather doubtful due to inconvenient navigation (it seems that railsapi.com is out of competition in this respect.). The only thing that may be of interest here is the user notes, which, in a difficult moment, can quickly answer the question that has arisen (although here, probably, it would be preferable to use the good old language on stackoverflow.com ).
It is best to use http://railsapi.com as your primary tool. As a quick collection of recipes, and online manuals for a thorough understanding of certain things - http://guides.rubyonrails.org . For setup / installation instructions - http://wiki.rubyonrails.org .
The rest is a matter of taste. Who knows, maybe one will like the austere design of official documentation, while others will like flashy shades of red on apidock.
The topic is inspired by a post about an online jQuery reference.
In this post, I would like to bring together a few useful, dedicated to Ruby on Rails, reference resources (including the API) that are always convenient to keep on hand, in the next browser tab.
It will be about:
- http://api.rubyonrails.org
- http://wiki.rubyonrails.org
- http://guides.rubyonrails.org
- http://railsapi.com
- http://apidock.com/rails
api.rubyonrails.org - official documentation
')
This is most likely the first online Ruby on Rails API reference book that will catch the eye of a novice RoR programmer. The user will not find anything special here - this is the official documentation, so it looks like a pure_rdoc_generated frame -based website. Navigating to C grade - you have to perform the search with a "dictionary in hand", because no built-in search.
It is recommended to get used to http://www.ruby-doc.org , the official documentation for Ruby :-)
wiki.rubyonrails.org
Resource other specificity than official API documentation. Here are presented, first of all, various articles, guides and FAQ on setting up, as well as various lists ( communities , hosting , etc.) are collected and introductory descriptions of work with this or that module are provided with brief code examples.
In general, the resource causes very contradictory feelings - on the one hand it is located on the official subdomain, on the other - in fact it turns out that there are very few articles, many of which are in a stub state, while others have long since lost their relevance. First of all, it is of interest as a collection of instructions for configuring and deploying an application, setting up communication with the database and installing plug-ins.
guides.rubyonrails.org
This resource is a collection of articles. It is closer to programming than wiki.rubyonrails.org . Here, in detail and with examples, there are large articles covering all aspects of using the framework: routing, rendering; comprehensively reviewed work with models and controllers. Each article is richly supplied with transparent examples. Among the maintainers of the project is Pratik Naik, which is part of the Rails Core Team.
Being a regular on stackoverflow.com , at first, I was repeatedly sent to read an article on a topic that interests me.
railsapi.com
Personal favorite. On the site there is super-convenient navigation with search and a pleasant interface. Implemented on the basis of frames with a small use of JavaScript'a. The directory itself seems to be generated based on official documentation directly from the RoR sources. And although, in theory, it is only a decorated copy of the official version, the inscription on the main one (
Last modified: 2009-12-29 20:23:32 +0000 ) still makes you think about the preference of this particular directory to the official one (see the first screenshot ).Search by methods is performed not only full-text (the search engine is not too lazy to search, including somewhere in the middle of the name), but the so-called smart search: for example, at the request of round , among other things, the method p r oxy_f ound will be found (which is of course good, but it is not clear when this may be necessary).
Pleasant, ascetic design does not distract from searching and reading information. The speed of work is also good - the delay in loading a new page is almost imperceptible (on channel 512 Kb).
The younger brother railsapi.com - railsbrain.com is also present on the Internet . In this review, he did not get the sight of the fact that in addition to the ajax-wrapper (in fact, only search) over off. documentation, it is no longer remarkable.
apidock.com/rails
Generated based on official documentation. For each individual article in the directory, you can write a note (which, in fact, the users registered there do). Notes usually contain various undocumented techniques for using the methods described in the article. Also, each article is assigned a special character by which the documentation of the class or module under consideration is determined. In addition, each article has a timeline version of Rails, which can be used to determine how the article has changed from version to version.
Using the directory in everyday mode seems rather doubtful due to inconvenient navigation (it seems that railsapi.com is out of competition in this respect.). The only thing that may be of interest here is the user notes, which, in a difficult moment, can quickly answer the question that has arisen (although here, probably, it would be preferable to use the good old language on stackoverflow.com ).
Conclusion
It is best to use http://railsapi.com as your primary tool. As a quick collection of recipes, and online manuals for a thorough understanding of certain things - http://guides.rubyonrails.org . For setup / installation instructions - http://wiki.rubyonrails.org .
The rest is a matter of taste. Who knows, maybe one will like the austere design of official documentation, while others will like flashy shades of red on apidock.
The topic is inspired by a post about an online jQuery reference.
Source: https://habr.com/ru/post/82605/
All Articles