diff --git a/docs/learn/deploy/3-third-party.rst b/docs/learn/deploy/3-third-party.rst index de87db27b..0ffa206ad 100644 --- a/docs/learn/deploy/3-third-party.rst +++ b/docs/learn/deploy/3-third-party.rst @@ -13,13 +13,17 @@ Studies built in ``lab.js`` integrate well with external tools, and will happil .. seealso:: - This page covers integration with third-party tools in general. We cover the most popular tools individually: + This page covers integration with third-party tools in the abstract. We cover the most popular tools individually: * :ref:`Open Lab ` * :ref:`JATOS ` * :ref:`Qualtrics ` * :ref:`The Experiment Factory ` +.. |br| raw:: html + +
+ ---- .. _tutorial/deploy/third-party: @@ -36,17 +40,30 @@ This means that you'll need a couple of things for this to work: ---- +.. _tutorial/deploy/third-party/prepare-experiment: + Prepare the experiment ---------------------- -The first step is to **prepare the experiment you've built for use within external software**. Once you have a working study, all you need to do is export it using the *generic survey software* integration. This will give you a zip file; we'd ask you to unpack and upload it to a hosting provider of your choice. From there, you should be able to run the study using your browser; please make a note of the ``URL`` at which you accessed the study. +The first step is to **prepare the experiment you've built for use within external software**. Once you have a working study, please export it using the *generic survey software* integration. This will give you a zip archive with all the necessary files to run the study, pre-configured to send the data to a third-party service. + +After exporting the study, the next step is to **make it accessible to the survey software**. In most scenarios this means uploading the study files to a hosting provider or webspace. Some tools, notably JATOS and Open Lab, will host the study files for you, but others, you'll need to host the study yourself, outside of the survey. |br| +If your institution provides a server, or you have a personal webspace, you can unpack the study files there; if you don't, we like to use `Netlify Drop`_, which makes uploading and hosting a study a drag-and-drop operation (you'll need to setup a free account to permanently store your files with Netlify). + +Whereever you upload your study, please make a note of the ``URL`` at which it is accessible, you'll need it for the next step. + +.. _Netlify Drop: https://app.netlify.com/drop + +.. note:: + + **We're happy to help you with this!** We recognize that hosting a study can be a tricky step; please `join our support community `_ if there's anything we can support you with. ---- Prepare the survey ------------------ -Inside the survey, **you'll need to add a new text input field that will serve to capture and store the experiment's data**. Because we'll fill it with lots of strange-looking experimental data, it should ideally be hidden from participants (and not limited in length). You probably know best how to create this; **we've provided pointers for a few tools we've worked with below**. +Inside the survey, **you'll need to add a new text input field that will serve to capture and store the experiment's data**. Because we'll fill it with lots of strange-looking experimental data, it should ideally be hidden from participants (and not limited in length). You probably know best how to create this; **we've provided pointers for a few tools we've worked with above**. ---- @@ -79,7 +96,7 @@ To process and save the data, the surrounding page needs to capture the results diff --git a/docs/learn/deploy/3a-qualtrics.rst b/docs/learn/deploy/3a-qualtrics.rst index b72d870e6..2ed1378ae 100644 --- a/docs/learn/deploy/3a-qualtrics.rst +++ b/docs/learn/deploy/3a-qualtrics.rst @@ -5,6 +5,8 @@ Working with Qualtrics `Qualtrics`_ is a popular proprietary questionnaire and survey tool that is easy to pick up. Studies built with ``lab.js`` can be embedded in Qualtrics with a few simple steps; setting up the connection should take you about 10 minutes. +Before you go through the steps below, please make sure that you've :ref:`prepared your study for use in third-party tools `. + .. _Qualtrics: https://www.qualtrics.com .. contents:: Steps