Skip to content

Commit

Permalink
Changed: Console becomes Dashboard, which is less confusing with rail…
Browse files Browse the repository at this point in the history
…s console (script/console).
  • Loading branch information
assaf committed Nov 19, 2009
1 parent 1048505 commit cb45b81
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/ab_testing.textile
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -145,9 +145,9 @@ def test_price_option
end
</pre>

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.

Expand Down
4 changes: 2 additions & 2 deletions doc/console.textile → doc/dashboard.textile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: page
title: Vanity Rails Console
title: The Dashboard
---

*Step 1:* Add a new resource in @config/routes.rb@:
Expand All @@ -13,7 +13,7 @@ map.resources :experiments, collection: { chooses: :post }

<pre>
class ExperimentsController < ApplicationController
include Vanity::Rails::ConsoleActions
include Vanity::Rails::Dashboard
end
</pre>

Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion doc/index.textile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/vanity/commands/report.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/vanity/rails.rb
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit cb45b81

Please sign in to comment.