@@ -31,7 +31,7 @@ end # DOC ======================================================================= desc 'Build all documentation' -task :doc => %w[doc:api doc:graphs doc:markdown] +task :doc => %w[doc:api doc:markdown] # requires the hanna gem: # gem install mislav-hanna --source=http://gems.github.com @@ -55,19 +55,6 @@ file 'doc/api/index.html' => FileList['lib/**/*.rb'] do |f| end CLEAN.include 'doc/api' -desc 'Build graphviz graphs' -task 'doc:graphs' -%w[pdf png svg].each do |filetype| - FileList["doc/*.dot"].each do |source| - dest = source.sub(/dot$/, filetype) - file dest => source do |f| - sh "dot -T#{filetype} #{source} -o #{f.name}" - end - task 'doc:graphs' => dest - CLEAN.include dest - end -end - desc 'Build markdown documentation files' task 'doc:markdown' FileList['doc/*.markdown'].each do |source| Rakefile @@ -2,8 +2,6 @@ - Move breakers.rb configuration file into rack-contrib as a middleware component. - - Add docs on using Rack::Cache with Rails 2.3 or link to one of the - existing tutorials on this. - Sample apps: Rack, Rails, Sinatra, Merb, etc. ## Backlog TODO @@ -10,6 +10,14 @@ General ------- +<a class='hash' id='rails' href='#rails'>#</a> + +### Q: Can I use Rack::Cache with Rails? + +Rack::Cache can be used with Rails 2.3 or above. Documentation and a +sample application is forthcoming; in the mean time, see +[this example of using Rack::Cache with Rails 2.3](http://snippets.aktagon.com/snippets/302-How-to-setup-and-use-Rack-Cache-with-Rails-2-3-0-RC-1). + <a class='hash' id='why-not-squid' href='#why-not-squid'>#</a> ### Q: Why Rack::Cache? Why not Squid, Varnish, Perlbol, etc.? doc/faq.markdown @@ -9,13 +9,13 @@ for [Rack][]-based applications that produce freshness (`Expires`, * Portable: 100% Ruby / works with any [Rack][]-enabled framework. * Disk, memcached, and heap memory [storage backends][storage]. -Status ------- +News +---- -__Rack::Cache__ is a young and experimental project that is likely to -change substantially and may not be wholly functional, consistent, -fast, or correct. The current focus is on reaching basic compliance -with RFC 2616 and providing good documentation. + * [How to use Rack::Cache with Rails 2.3](http://snippets.aktagon.com/snippets/302-How-to-setup-and-use-Rack-Cache-with-Rails-2-3-0-RC-1) - it's really easy. + * [RailsLab's Advanced HTTP Caching Screencast](http://railslab.newrelic.com/2009/02/26/episode-11-advanced-http-caching) + is a really great review of HTTP caching concepts and shows how to + use Rack::Cache with Rails. Installation ------------ @@ -51,7 +51,7 @@ caching. More ---- - * [Configuration and Options][config] - how to set cache options. + * [Configuration Options][config] - how to set cache options. * [Cache Storage Documentation][storage] - detailed information on the various storage implementations available in __Rack::Cache__ and how to choose the one doc/index.markdown doc/events.dot aa54db367c874987dd0df059f5a54f443c05373c Ryan Tomayko rtomayko@gmail.com http://github.com/rtomayko/rack-cache/commit/7b82c1136cb53835f2f538ee1d41c4d6867e16ed 7b82c1136cb53835f2f538ee1d41c4d6867e16ed 2009-03-07T22:33:32-08:00 2009-03-07T22:17:03-08:00 Clean up docs; links on using Rack::Cache with Rails 2.3 133cfea545b56ee8a4c15f1eee87d5f5247ea71b Ryan Tomayko rtomayko@gmail.com