kotovalexarian-likes-github/fog--fog
1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
Code Releases Activity

[docs] Replaces link to API to rubydoc.info

Browse source 
For historical reasons we generated and hosted our own versions of the
API docs, mostly so we could keep multiple versions.

http://rubydoc.info is giving this to the community for free amd also
works with github to offer the latest docs, so we have decided to stop
generating and hosting our own API docs.

This changes the link on `fog.io` to reference `rubydoc.info` instead
and removes the uploading rake task.

It does not remove the `yard` rake task so documentation can still be
generated locally.

Fixes #1274
This commit is contained in:
Paul Thornthwaite 2012-11-17 20:05:28 +00:00
parent 4aa14410b2
commit 87977857d3
2 changed files with 1 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Rakefile
View file

@ -270,7 +270,6 @@ end
task :docs do
Rake::Task[:supported_services_docs].invoke
Rake::Task[:upload_fog_io].invoke
Rake::Task[:upload_yardoc].invoke
# connect to storage provider
Fog.credential = :geemus
@ -396,36 +395,6 @@ task :upload_fog_io do
Formatador.redisplay("Uploaded docs/_site\n")
end
task :upload_yardoc do
# connect to storage provider
Fog.credential = :geemus
storage = Fog::Storage.new(:provider => 'AWS')
directory = storage.directories.new(:key => 'fog.io')
# write doc files to versioned 'folder'
Rake::Task[:yard].invoke
for file_path in Dir.glob("#{YARDOC_LOCATION}/**/*")
next if File.directory?(file_path)
file_name = file_path.gsub("#{YARDOC_LOCATION}/", '')
key = '' << version << "/#{YARDOC_LOCATION}/" << file_name
Formatador.redisplay(' ' * 128)
Formatador.redisplay("Uploading [bold]#{key}[/]")
directory.files.create(
:body => File.open(file_path),
:key => key,
:public => true
)
end
Formatador.redisplay(' ' * 128)
directory.files.create(
:body => redirecter("#{version}/#{YARDOC_LOCATION}/index.html"),
:content_type => 'text/html',
:key => "latest/#{YARDOC_LOCATION}/index.html",
:public => true
)
Formatador.redisplay("Uploaded yardoc\n")
end
def redirecter(path)
redirecter = <<-HTML
<!doctype html>

2
docs/index.markdown
View file

@ -58,7 +58,7 @@ geemus says: "That should give you everything you need to get started, but let m
Enjoy, and let me know what I can do to continue improving fog!
* Work through the [fog tutorial](https://github.com/downloads/geemus/learn_fog/learn_fog.tar.gz)
* Read fog's [API documentation](/doc)
* Read fog's API documentation [master branch](http://rubydoc.info/github/fog/fog) or [latest gem release](http://rubydoc.info/gems/fog)
* Stay up to date by following [@fog](http://twitter.com/fog) and/or [@geemus](http://twitter.com/geemus) on Twitter.
* Get and give help on the [#ruby-fog](irc://irc.freenode.net/ruby-fog) irc channel on Freenode
* Follow release notes and discussions on the [mailing list](http://groups.google.com/group/ruby-fog)