From 4d14273ccb12e15a544a12ccb330d014cf0198dc Mon Sep 17 00:00:00 2001 From: Assaf Arkin Date: Wed, 18 Nov 2009 20:37:38 -0800 Subject: [PATCH] Changed: Console becomes Dashboard, which is less confusing with rails console (script/console). --- CHANGELOG | 1 + Rakefile | 2 +- doc/ab_testing.textile | 6 +++--- doc/{console.textile => dashboard.textile} | 4 ++-- doc/images/{ab_console.png => ab_in_dashboard.png} | Bin doc/index.textile | 2 +- lib/vanity/commands/report.rb | 2 +- lib/vanity/rails.rb | 2 +- lib/vanity/rails/{console.rb => dashboard.rb} | 2 +- 9 files changed, 11 insertions(+), 10 deletions(-) rename doc/{console.textile => dashboard.textile} (84%) rename doc/images/{ab_console.png => ab_in_dashboard.png} (100%) rename lib/vanity/rails/{console.rb => dashboard.rb} (93%) diff --git a/CHANGELOG b/CHANGELOG index 0c4a564a..e4aba65a 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -18,6 +18,7 @@ In addition, the ab_goal! method is now track!. This method may be used for oth * Changed: You can break long experiment descriptions into multiple paragraphs using two consecutive newlines. * Changed: AbTest confidence becomes probability; only returns choice alternative with probability equal or higher than that. * Changed: ab_goal! becomes track!. +* Changed: Console becomes Dashboard, which is less confusing with rails console (script/console). == 0.3.1 (2009-11-13) * Changed: Redis 1.0 is now vendored into Vanity. This means one less dependecy ... actually two, since Redis brings with it RSpec. diff --git a/Rakefile b/Rakefile index b821bfdc..a62dc35e 100644 --- a/Rakefile +++ b/Rakefile @@ -46,7 +46,7 @@ file ".site/api"=>"yardoc" do cp_r ".api", ".site/apm" end desc "Push site to server" -task :publish=>[".site", ".site/api"] do +task :publish=>[:clobber, ".site", ".site/api"] do sh "rsync -cr --del --progress .site/ labnotes.org:/var/www/vanity/" end task :clobber do diff --git a/doc/ab_testing.textile b/doc/ab_testing.textile index 2716d855..66d5ff33 100644 --- a/doc/ab_testing.textile +++ b/doc/ab_testing.textile @@ -49,7 +49,7 @@ end h3. Interpreting the Results -We're going to let the experiment run for a while and track the results using the "console":console.html, or by running the command @vanity report@. +We're going to let the experiment run for a while and track the results using "the dashboard":dashboard.html, or by running the command @vanity report@. Vanity splits the audience randomly -- using "cookies and other mechanisms":identity.html -- and records who got to see each alternative, and how many in each group converted (in our case, signed up). Dividing conversions by participants gives you the conversion rate. @@ -145,9 +145,9 @@ def test_price_option end -You'll also want to test each alternative visually, from your Web browser. For that you'll have to install the "Vanity Rails Console":console.html, which lets you pick which alternative is shown to you: +You'll also want to test each alternative visually, from your Web browser. For that you'll have to install the "the Dashboard":dashboard.html, which lets you pick which alternative is shown to you: -!images/ab_console.png! +!images/ab_in_dashboard.png! Once the experiment is over, simply remove its definition from the experiments directory and run the test suite again. You'll see errors in all the places that touch the experiment (from failing to load it), pointing you to what parts of the code you need to remove/change. diff --git a/doc/console.textile b/doc/dashboard.textile similarity index 84% rename from doc/console.textile rename to doc/dashboard.textile index 9728f27f..187799e1 100644 --- a/doc/console.textile +++ b/doc/dashboard.textile @@ -1,6 +1,6 @@ --- layout: page -title: Vanity Rails Console +title: The Dashboard --- *Step 1:* Add a new resource in @config/routes.rb@: @@ -13,7 +13,7 @@ map.resources :experiments, collection: { chooses: :post } 
 class ExperimentsController < ApplicationController
-  include Vanity::Rails::ConsoleActions
+  include Vanity::Rails::Dashboard
 end
diff --git a/doc/images/ab_console.png b/doc/images/ab_in_dashboard.png similarity index 100% rename from doc/images/ab_console.png rename to doc/images/ab_in_dashboard.png diff --git a/doc/index.textile b/doc/index.textile index e8c58ab3..8cd0644d 100644 --- a/doc/index.textile +++ b/doc/index.textile @@ -13,7 +13,7 @@ h3. Reading Order * "Introduction":#intro * "A/B Testing":ab_testing.html -* "Rails Console":console.html +* "The Dashboard":dashboard.html * "Managing Identity":identity.html * "Configuring Vanity":configuring.html * "API reference":api/index.html diff --git a/lib/vanity/commands/report.rb b/lib/vanity/commands/report.rb index 23b1d11b..578d4361 100644 --- a/lib/vanity/commands/report.rb +++ b/lib/vanity/commands/report.rb @@ -7,7 +7,7 @@ module Vanity # outside Rails). module Render - # Render the named template. Used for reporting and the console. + # Render the named template. Used for reporting and the dashboard. def render(path, locals = {}) locals[:playground] = self keys = locals.keys diff --git a/lib/vanity/rails.rb b/lib/vanity/rails.rb index b35b3a6a..c6dabeb1 100644 --- a/lib/vanity/rails.rb +++ b/lib/vanity/rails.rb @@ -1,7 +1,7 @@ require "vanity" require "vanity/rails/helpers" require "vanity/rails/testing" -require "vanity/rails/console" +require "vanity/rails/dashboard" # Use Rails logger by default. Vanity.playground.logger ||= ActionController::Base.logger diff --git a/lib/vanity/rails/console.rb b/lib/vanity/rails/dashboard.rb similarity index 93% rename from lib/vanity/rails/console.rb rename to lib/vanity/rails/dashboard.rb index 9107b599..d9855c17 100644 --- a/lib/vanity/rails/console.rb +++ b/lib/vanity/rails/dashboard.rb @@ -1,6 +1,6 @@ module Vanity module Rails - module ConsoleActions + module Dashboard def index render Vanity.template("_report"), content_type: Mime::HTML, layout: true end