api.rubyonrails.org previous versions?

97 views
Skip to first unread message

Josh

unread,
Jul 11, 2012, 3:12:37 PM7/11/12
to rubyonra...@googlegroups.com
First, let me say that api.rubyonrails.org is awesome.  Whoever is hosting it - thank you.  It blows all the other api tools out of the water in terms of usability.  Yay!

That said, how come http://api.rubyonrails.org/v3.0.15 doesn't show me the 3.0.15 docs?  3.0.x is still actively maintained and supported.  What about any other old version. I'm sure some folks would find this very useful.  It is exceedingly difficult to get decent-to-use docs for old versions of rails.

Think we can make that happen somehow?

Love,
Josh

P.S. Same could be said for the guides.rubyonrails.org.  I'm aware http://guides.rubyonrails.org/v2.3.8/ is available, but that's just because it's ingrained.  As far as I can tell it's not readily linked to anymore.  Are there other versions of the guides?

Walter Lee Davis

unread,
Jul 11, 2012, 3:16:28 PM7/11/12
to rubyonra...@googlegroups.com

On Jul 11, 2012, at 3:12 PM, Josh wrote:

> First, let me say that api.rubyonrails.org is awesome. Whoever is hosting it - thank you. It blows all the other api tools out of the water in terms of usability. Yay!
>
> That said, how come http://api.rubyonrails.org/v3.0.15 doesn't show me the 3.0.15 docs? 3.0.x is still actively maintained and supported. What about any other old version. I'm sure some folks would find this very useful. It is exceedingly difficult to get decent-to-use docs for old versions of rails.
>
> Think we can make that happen somehow?

Have you tried apidock yet? That has a picker for what version you are using, and shows when a particular function was deprecated. Very handy for this sort of thing.

Walter

>
> Love,
> Josh
>
> P.S. Same could be said for the guides.rubyonrails.org. I'm aware http://guides.rubyonrails.org/v2.3.8/ is available, but that's just because it's ingrained. As far as I can tell it's not readily linked to anymore. Are there other versions of the guides?
>
> --
> You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group.
> To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-talk/-/Xuzl3IE44QAJ.
> To post to this group, send email to rubyonra...@googlegroups.com.
> To unsubscribe from this group, send email to rubyonrails-ta...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en-US.

Frederick Cheung

unread,
Jul 12, 2012, 5:52:20 AM7/12/12
to Ruby on Rails: Talk


On Jul 11, 8:12 pm, Josh <josh.m.sha...@gmail.com> wrote:
> First, let me say that api.rubyonrails.org is awesome.  Whoever is hosting
> it - thank you.  It blows all the other api tools out of the water in terms
> of usability.  Yay!
>
> That said, how comehttp://api.rubyonrails.org/v3.0.15doesn't show me the
> 3.0.15 docs?  3.0.x is still actively maintained and supported.  What about
> any other old version. I'm sure some folks would find this very useful.  It
> is exceedingly difficult to get decent-to-use docs for old versions of
> rails.
>
> Think we can make that happen somehow?
>
even if the powers that be don't want to make it happen

cd your_app
touch README.rdoc
rake doc:rails

This will dump the rdoc documentation for the rails version in doc/
api.

Unfortunately at the moment that will use a different template to
api.rubyonrails.org (if you're using an older version of rails it
might not matter)

You can hack things by:

- adding sdoc to your bundle
- edit documentation.rake (in the railties gem) and add

require 'sdoc' #at the top of the file

Change the options passed to rdoc in the rails task

rdoc.options << '--line-numbers'
rdoc.options << '-f' << 'sdoc'
rdoc.options << '-T' << 'rails'
rdoc.options << '-e' << 'UTF-8'

Remove doc/api, rerun rake doc:api and you should have api docs that
look like the ones on api.rubyonrails.org (you need to serve them
through an actual web server (e.g. thin -A file start), the links
don't work when accessed via file:/// urls)

You can generate the guides too. First check that you have the
RedCloth gem in your bundle. then run rake doc:guides and all the
guides will be generated in doc/guides


> P.S. Same could be said for the guides.rubyonrails.org.  I'm
> awarehttp://guides.rubyonrails.org/v2.3.8/is available, but that's just
> because it's ingrained.  As far as I can tell it's not readily linked to
> anymore.  Are there other versions of the guides?

The guides front page links to http://guides.rubyonrails.org/v2.3.11
Seems like you can pop any 3.1.x or 3.2.x version number in there

Fred

Josh

unread,
Jul 14, 2012, 8:15:52 AM7/14/12
to rubyonra...@googlegroups.com
Yea, I know how to generate my own docs, and apidock is... okay.  Both of the proposed solutions so far are missing the point.  api.rubyonrails.org should host, at a minimum, all currently supported versions.  Once that's done it should be trivial to support as far back as the docs remain in the same format.

arcasys

unread,
Jul 26, 2014, 10:12:52 AM7/26/14
to rubyonra...@googlegroups.com
I strongly support Josh's opinion. It's extremely hard to find information on specific rails versions and you can't even tell which version you're currently following when you're reading a guide. It's a pity that the maintainers seem to not care much about people not living on the edge.
What about a delivery point where people could drop the documentation they've generated for specific releases and make it available to the community?
MySQL for example has a full set of documentation for each release ...
Reply all
Reply to author
Forward
0 new messages