Skip to content

Commit

Permalink
clean up sections, and some of the links
Browse files Browse the repository at this point in the history
  • Loading branch information
mizzao committed Jun 17, 2016
1 parent a5529b6 commit c67dee6
Show file tree
Hide file tree
Showing 30 changed files with 127 additions and 393 deletions.
12 changes: 1 addition & 11 deletions source/architecture/admin-console.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
---
layout: default
title: Live Experimenter View
slug: admin-console
permalink: admin-console
icon: fa fa-server
category: overview
order: 2
---

# Live Experimenter View

TurkServer has a built-in administration interface at `/turkserver`, providing a
real-time view of everything that is happening with your users and in your
experiments. You can use this to manage batches, manage treatments, view the
progress of experiments, and post HITs to recruit subjects.

![admin console](img/turkserver.png)
![admin console](../_static/turkserver.png)

A brief overview of the different sections:

Expand Down
27 changes: 9 additions & 18 deletions source/architecture/alternatives.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Alternative Platforms
slug: alternatives
permalink: alternatives
published: true
icon: fa fa-share-alt
category: overview
order: 10
---
# Alternative Platforms

There are many other platforms released by academics for doing online
experiments. Here are a list of the ones we know that are currently active.
Expand Down Expand Up @@ -37,14 +28,6 @@ volunteer panel.

[vs]: https://volunteerscience.com/

<!--
Other references, stuff that is not well supported
[SoPHIE][sophie]
[sophie]: http://www.sophie.uni-osnabrueck.de/
http://cogsci.stackexchange.com/questions/109
-->

Unless using volunteer participants, all of the aforementioned software
frameworks run on crowdsourcing platforms:

Expand All @@ -58,3 +41,11 @@ that may supplement or replace Mechanical Turk in the future.
[mturk]: https://www.mturk.com/
[prolific]: https://prolific.ac/
[crowdsourcing]: https://www.quora.com/Are-there-any-similar-services-to-Amazon-Mechanical-Turk

<!--
Other references, stuff that is not well supported
[SoPHIE][sophie]
[sophie]: http://www.sophie.uni-osnabrueck.de/
http://cogsci.stackexchange.com/questions/109
-->
14 changes: 1 addition & 13 deletions source/architecture/architecture.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
---
layout: default
author:
title: System Overview
slug: overview
permalink: overview
published: true
icon: fa fa-cog fa-spin
category: navigation
order: 3
---

# Architecture Overview

TurkServer is a full-stack Javascript framework based on [Meteor][meteor].
Expand All @@ -18,7 +6,7 @@ This means you do all your programming in Javascript, on both the client-side

[meteor]: https://www.meteor.com/

<img src="img/arch/stack.png" width="40%">
<img src="../_static/arch/stack.png" width="60%">

Why is TurkServer designed this way, and what are the core concepts?

Expand Down
10 changes: 1 addition & 9 deletions source/architecture/research-methods.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
---
layout: default
title: Research Methods
slug: research-methods
permalink: research-methods
icon:
category: overview
order: 8
---
# Research Methods

The original design of TurkServer was described in the following paper. The
current version (based on Meteor) is not yet published, so please feel free
Expand Down
10 changes: 0 additions & 10 deletions source/architecture/treatments.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
---
layout: default
title: Treatments API
slug: treatments
permalink: treatments
icon: fa fa-tag
category: overview
order: 5
---

# Treatments

Treatments can have structured data which are made
Expand Down
10 changes: 0 additions & 10 deletions source/architecture/why-meteor.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
---
layout: default
title: Why Meteor?
slug: why-meteor
permalink: why-meteor
icon: fa fa-question
category: overview
order: 0
---

# Why Meteor?

For many years, web programming has been a drag. Developers used Javascript on
Expand Down
12 changes: 1 addition & 11 deletions source/architecture/world-assignment.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
---
layout: default
title: Worlds and Assignment
slug: world-assignment
permalink: world-assignment
icon: fa fa-random
category: overview
order: 1
---

# Batches
# Worlds and Assignment

TurkServer uses the concept of **batches** to logically group
instances of experiments together. Each batch limits repeat
Expand Down
11 changes: 1 addition & 10 deletions source/design/assigning-matching.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Assignment and Matching
slug: assignment-matching
permalink: assignment-matching
published: true
icon: fa fa-random
category: design
order: 2
---
# Assignment and Matching

### Matching Issues:

Expand Down
11 changes: 1 addition & 10 deletions source/design/debugging.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Debugging and Testing
slug: debugging
permalink: debugging
published: true
icon: fa fa-bug
category: design
order: 9
---
# Debugging and Testing

Debug your app thoroughly in local mode before launching on MTurk.
Grab some friends or use multiple browsers. Test things like dropouts,
Expand Down
18 changes: 4 additions & 14 deletions source/design/design.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
---
layout: default
author:
title: Design Guide
slug: design
permalink: design
published: true
icon: fa fa-lightbulb-o
category: navigation
order: 4
---
# Design Overview

# Typical Workflow using TurkServer
## Typical Workflow using TurkServer

[cm]: https://github.com/TurkServer/CrowdMapper
[pd]: https://github.com/TurkServer/long-run-cooperation
Expand Down Expand Up @@ -45,7 +35,7 @@ better to do this in testing than to shoot from the hip.
5. Share the source code of your app so others can look at your experiment
protocol, and replicate or build on it.

# Designing Good Experiments
## Designing Good Experiments

While TurkServer provides much of the software components necessary
for deploying web-based experiments, many elements of your
Expand All @@ -58,7 +48,7 @@ that affect how well you can collect data when your app is live. Consider the
following "state diagram" (credit: Eshin Jolly) that illustrates possible
conditions a user passes through as they participate in a group task:

![example flow](img/design/experiment-flow.png)
![example flow](../_static/design/experiment-flow.png)

Among other things, the diagram illustrates:

Expand Down
11 changes: 1 addition & 10 deletions source/design/disconnection.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Disconnection and Dropout
slug: disconnection
permalink: disconnection
published: true
icon: fa fa-plug
category: design
order: 4
---
# Disconnection and Dropout

Users may disconnect and reconnect to your experiment, or leave without
coming back. A good experiment design accounts for this and minimizes the
Expand Down
11 changes: 1 addition & 10 deletions source/design/faq.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Frequently Asked Questions
slug: faq
permalink: faq
published: true
icon: fa fa-question-circle
category: design
order: 20
---
# Frequently Asked Questions

> I don't want to or can't write code. Can I hire a developer to build my web
application (experiment) for me?
Expand Down
11 changes: 1 addition & 10 deletions source/design/good-instructions.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Providing Good Instructions
slug: good-instructions
permalink: good-instructions
published: true
icon: fa fa-book
category: design
order: 3
---
# Providing Good Instructions

### Social Issues:

Expand Down
11 changes: 1 addition & 10 deletions source/design/minimizing-attrition.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Minimizing Attrition
slug: attrition
permalink: attrition
published: true
icon:
category: design
order: 12
---
# Minimizing Attrition

- Set expectations for involvement
- Financial incentives
Expand Down
23 changes: 7 additions & 16 deletions source/design/one-way-mirror.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
---
layout: default
title: One-way Mirror
slug: mirror
permalink: mirror
published: true
icon: fa fa-photo
category: design
order: 8
---
# One-way Mirror

![one-way mirror](http://www.todayifoundout.com/wp-content/uploads/2010/05/one-way-mirror.jpg)

A one-way mirror is used in some physical lab experiments to allow
unobtrusive observation of participants. Using the real-time capabilities of
Meteor, this is actually fairly easy to set up on an existing app.

# Creating a digital one-way mirror
## Creating a digital one-way mirror

In the [worlds and assignment](world-assignment) section, we explained how
TurkServer is designed around multiple worlds that participants can be assigned
Expand Down Expand Up @@ -130,14 +121,14 @@ Under the **Experiments** view of the admin console, this will create a
convenient button that you can click to watch ongoing or completed
experiments (worlds) in real time.

![data button](img/experiments4.png)
![data button](../_static/experiments4.png)

# Examples
## Examples

Although the code for a one-way mirror is minimal, it may help to look at the
following implementations for inspiration.

## Crisis Mapping
### Crisis Mapping

[![CrowdMapper Replay](http://share.gifyoutube.com/mLnMWR.gif)][cm-paper]

Expand All @@ -152,9 +143,9 @@ observation over a number of different collections, producing the
[cm-client]: https://github.com/TurkServer/CrowdMapper/blob/master/client/admin.coffee
[cm-server]: https://github.com/TurkServer/CrowdMapper/blob/master/server/server.coffee#L38

## Prisoner's Dilemma
### Prisoner's Dilemma

![PD Mirror](img/design/pd-mirror.png)
![PD Mirror](../_static/design/pd-mirror.png)

This one-way mirror uses much simpler data, but also uses [D3][d3] to build
a real-time visualization showing the experimenter much more than
Expand Down
11 changes: 1 addition & 10 deletions source/design/software.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
---
layout: default
title: Helpful Software
slug: software
permalink: software
published: true
icon: fa fa-info
category: design
order: 15
---
# Helpful Software

Meteor already makes it pretty easy to design a reactive and responsive user interface, but you may find some of the following packages useful.

Expand Down
16 changes: 3 additions & 13 deletions source/examples/examples.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
---
layout: default
author:
title: Examples
slug: examples
permalink: examples
published: true
icon: fa fa-flask
category: navigation
order: 2
---
# Examples

# Basic Examples
## Basic Examples

The basic [tutorial](tutorial) describes how to build a simple, but full
fledged example app ([see source code](https://github.com/TurkServer/tutorial).)
Take a look at this app as a working starting point for something you can
deploy online.

# Research Projects
## Research Projects

Although studies of individual behavior are desirable and easy to build,
TurkServer really shines for studying groups, especially for complex
Expand Down

0 comments on commit c67dee6

Please sign in to comment.