Split form study details (#443)

* Add sphinx development server * Update language about "create study" button * Update screenshots * create study screen shot * Study list screenshot * Study edit image * Study submission modal image * Update a few lab view screen shots * Study detail image needed more of the page view * Update to all responses images * Update study videos download image * Update demo and responses images * Update login images * Remove OSF account migration section * A few images for the update code docs * Update for wiki images * Update to "Updating EFP" section * Remove unneeded external section from study fields docs The external info has been moved to "Experiment Type" selection at the bottom of this documentation.
lookit · Dec 13, 2024 · d08bdbd · d08bdbd
1 parent af76401
commit d08bdbd
Show file tree

Hide file tree

Showing 54 changed files with 81 additions and 57 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -17,4 +17,7 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml:
+	sphinx-autobuild --port=9999 "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,9 +1,13 @@
 alabaster==1.0.0
+anyio==4.6.2.post1
 babel==2.16.0
 certifi==2024.8.30
 charset-normalizer==3.4.0
+click==8.1.7
+colorama==0.4.6
 commonmark==0.9.1
 docutils==0.21.2
+h11==0.14.0
 idna==3.10
 imagesize==1.4.1
 Jinja2==3.1.4
@@ -12,8 +16,10 @@ packaging==24.2
 Pygments==2.18.0
 recommonmark==0.7.1
 requests==2.32.3
+sniffio==1.3.1
 snowballstemmer==2.2.0
 Sphinx==8.1.3
+sphinx-autobuild==2024.10.3
 sphinx-rtd-theme==3.0.2
 sphinxcontrib-applehelp==2.0.0
 sphinxcontrib-devhelp==2.0.0
@@ -22,4 +28,8 @@ sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==2.0.0
 sphinxcontrib-serializinghtml==2.0.0
+starlette==0.41.3
 urllib3==2.2.3
+uvicorn==0.32.1
+watchfiles==1.0.0
+websockets==14.1
diff --git a/docs/source/_static/img/all_responses.png b/docs/source/_static/img/all_responses.png
diff --git a/docs/source/_static/img/all_responses_options.png b/docs/source/_static/img/all_responses_options.png
diff --git a/docs/source/_static/img/attachments.png b/docs/source/_static/img/attachments.png
diff --git a/docs/source/_static/img/create_study.png b/docs/source/_static/img/create_study.png
diff --git a/docs/source/_static/img/demographics.png b/docs/source/_static/img/demographics.png
diff --git a/docs/source/_static/img/labs/initial_lab_list.png b/docs/source/_static/img/labs/initial_lab_list.png
diff --git a/docs/source/_static/img/labs/lab_detail.png b/docs/source/_static/img/labs/lab_detail.png
diff --git a/docs/source/_static/img/labs/lab_list.png b/docs/source/_static/img/labs/lab_list.png
diff --git a/docs/source/_static/img/login/login.png b/docs/source/_static/img/login/login.png
diff --git a/docs/source/_static/img/login/login_2fa.png b/docs/source/_static/img/login/login_2fa.png
diff --git a/docs/source/_static/img/login/login_2fa_disabled.png b/docs/source/_static/img/login/login_2fa_disabled.png
diff --git a/docs/source/_static/img/login/login_2fa_error.png b/docs/source/_static/img/login/login_2fa_error.png
diff --git a/docs/source/_static/img/login/login_2fa_management.png b/docs/source/_static/img/login/login_2fa_management.png
diff --git a/docs/source/_static/img/login/login_2fa_setup.png b/docs/source/_static/img/login/login_2fa_setup.png
diff --git a/docs/source/_static/img/login/login_homepage_link.png b/docs/source/_static/img/login/login_homepage_link.png
diff --git a/docs/source/_static/img/login/login_homepage_registration_link.png b/docs/source/_static/img/login/login_homepage_registration_link.png
diff --git a/docs/source/_static/img/login/login_participant_registration.png b/docs/source/_static/img/login/login_participant_registration.png
diff --git a/docs/source/_static/img/login/login_password_reset.png b/docs/source/_static/img/login/login_password_reset.png
diff --git a/docs/source/_static/img/login/login_password_reset_complete.png b/docs/source/_static/img/login/login_password_reset_complete.png
diff --git a/docs/source/_static/img/login/login_password_reset_link.png b/docs/source/_static/img/login/login_password_reset_link.png
diff --git a/docs/source/_static/img/login/login_previous_account_redirect.png b/docs/source/_static/img/login/login_previous_account_redirect.png
diff --git a/docs/source/_static/img/login/login_researcher_manage_account.png b/docs/source/_static/img/login/login_researcher_manage_account.png
diff --git a/docs/source/_static/img/login/login_researcher_registration.png b/docs/source/_static/img/login/login_researcher_registration.png
diff --git a/docs/source/_static/img/login/login_success_redirect.png b/docs/source/_static/img/login/login_success_redirect.png
diff --git a/docs/source/_static/img/responses.png b/docs/source/_static/img/responses.png
diff --git a/docs/source/_static/img/study_detail.png b/docs/source/_static/img/study_detail.png
diff --git a/docs/source/_static/img/study_detail_all_buttons.png b/docs/source/_static/img/study_detail_all_buttons.png
diff --git a/docs/source/_static/img/study_detail_limited_options.png b/docs/source/_static/img/study_detail_limited_options.png
diff --git a/docs/source/_static/img/study_edit.png b/docs/source/_static/img/study_edit.png
diff --git a/docs/source/_static/img/study_list.png b/docs/source/_static/img/study_list.png
diff --git a/docs/source/_static/img/study_submission_comment.png b/docs/source/_static/img/study_submission_comment.png
diff --git a/docs/source/_static/img/update_code/blank_sha.png b/docs/source/_static/img/update_code/blank_sha.png
diff --git a/docs/source/_static/img/update_code/branch_list.png b/docs/source/_static/img/update_code/branch_list.png
diff --git a/docs/source/_static/img/update_code/build_preview.png b/docs/source/_static/img/update_code/build_preview.png
diff --git a/docs/source/_static/img/update_code/change_state.png b/docs/source/_static/img/update_code/change_state.png
diff --git a/docs/source/_static/img/update_code/click_save.png b/docs/source/_static/img/update_code/click_save.png
diff --git a/docs/source/_static/img/update_code/commit_detail.png b/docs/source/_static/img/update_code/commit_detail.png
diff --git a/docs/source/_static/img/update_code/commit_from_release.png b/docs/source/_static/img/update_code/commit_from_release.png
diff --git a/docs/source/_static/img/update_code/commit_list.png b/docs/source/_static/img/update_code/commit_list.png
diff --git a/docs/source/_static/img/update_code/edit_study.png b/docs/source/_static/img/update_code/edit_study.png
diff --git a/docs/source/_static/img/update_code/filled_sha.png b/docs/source/_static/img/update_code/filled_sha.png
diff --git a/docs/source/_static/img/update_code/initial_state.png b/docs/source/_static/img/update_code/initial_state.png
diff --git a/docs/source/_static/img/update_code/preview_detail_page.png b/docs/source/_static/img/update_code/preview_detail_page.png
diff --git a/docs/source/_static/img/update_code/preview_enabled.png b/docs/source/_static/img/update_code/preview_enabled.png
diff --git a/docs/source/_static/img/wiki/all_responses.png b/docs/source/_static/img/wiki/all_responses.png
diff --git a/docs/source/_static/img/wiki/download_videos.png b/docs/source/_static/img/wiki/download_videos.png
diff --git a/docs/source/_static/img/wiki/editing_researcher_permissions.png b/docs/source/_static/img/wiki/editing_researcher_permissions.png
diff --git a/docs/source/_static/img/wiki/study_start.png b/docs/source/_static/img/wiki/study_start.png
diff --git a/docs/source/researchers-log-in.rst b/docs/source/researchers-log-in.rst
@@ -21,27 +21,7 @@ Logging in
 
    .. image:: _static/img/login/login_2fa.png
     :alt: 2FA login prompt
-
-If you created your account via OSF (i.e. before August 2020)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-   The first time you log in to CHS after OSF login is unavailable, you will need to 
-   click "Forgot password?" to request a password reset link.
-
-    .. image:: _static/img/login/login_password_reset_link.png
-        :alt: Password reset link on login view
-
-   Follow the link you receive by email to set a new password for your account:
-
-    .. image:: _static/img/login/login_password_reset.png
-        :alt: Password reset form
-
-   When you log in again, you will be redirected to two-factor authentication setup so you can use the researcher section of CHS!
-
-    .. image:: _static/img/login/login_previous_account_redirect.png
-        :alt: Prompt to set up 2FA for previous account
-
-
+
 Creating a researcher account
 --------------------------------------
 

diff --git a/docs/source/researchers-manage-studies.rst b/docs/source/researchers-manage-studies.rst
@@ -15,7 +15,7 @@ You can filter studies by name or by keywords in the description. Additionally,
 ===================
 Creating a study
 ===================
-To create a study, click the green "Create Study" button on the study list page or navigate to /exp/studies/create/. You'll need to provide values for the fields as described in `Setting study fields`_.
+To create a study, click the "Create Study" button on the `Study list page`_ or go directly to the `Create study page`_. You'll need to provide values for the fields as described in `Setting study fields`_.
 
 .. image:: _static/img/create_study.png
     :alt: Creating a study
@@ -179,4 +179,8 @@ For external studies, the "Edit Study Design" page allows you to edit the follow
 
 .. _`Setup for custom frame development`: frame-dev-setup.html
 
-.. _`Setting study fields`: researchers-set-study-fields.html
+.. _`Setting study fields`: researchers-set-study-fields.html
+
+.. _`study list page`: https://childrenhelpingscience.com/exp/studies/
+
+.. _`create study page`: https://childrenhelpingscience.com/exp/studies/create/
diff --git a/docs/source/researchers-set-study-fields.rst b/docs/source/researchers-set-study-fields.rst
@@ -27,11 +27,6 @@ This value affects the order in which studies are listed on your :ref:`custom la
 
 Setting your study's priority value to 99 (the default) will mean it is shown *first* on your page, while setting the priority to 1 will mean it is shown *last*. You can use any integers between these values for more fine-grained control over ordering. If any of your lab's studies share the same priority value, then presentation order will be random within that set. 
 
-=============================
-External
-=============================
-Will you be providing a link to a study (or study scheduling page) rather than using the Lookit or jsPsych experiment builders? If so, then check this box to show the form fields that are relevant to these types of studies, such as the study/scheduling link (see :ref:`study-url`). Checking this box will also hide fields of this form that are only applicable for internal Lookit/jsPsych studies. Leave this box unchecked if you are building an experiment to be conducted inside the CHS architecture (i.e. an 'internal' study; see `Building an Experiment`_ for more information).  
-
 =============================
 Scheduled
 =============================

diff --git a/docs/source/researchers-update-code.rst b/docs/source/researchers-update-code.rst
@@ -4,72 +4,90 @@
 Updating the Lookit experiment runner
 #############################################
 
-In the future, there may be changes in the Lookit experiment runner that you want your study to use - for instance, a bug fix for an issue your participants are encountering or a new frame you want to use. (By default, your study keeps chugging along using exactly the same code, so that updates can't change how your study works without your knowledge.) 
+In the future, there may be changes in the Lookit experiment runner that you 
+want your study to use - for instance, a bug fix for an issue your participants 
+are encountering or a new frame you want to use. (By default, your study keeps 
+chugging along using exactly the same code, so that updates can't change how 
+your study works without your knowledge.) 
 
 Checking what's changed
 -------------------------
 
-The most straightforward way to view changes to the Lookit code is to review the list of 
-`releases <https://github.com/lookit/ember-lookit-frameplayer/releases>`__. If you're 
-planning to update to the latest version, you should read through the release notes for 
-each version between the one you're using and the new one. 
-
-The releases are numbered v<MAJOR>.<MINOR>.<PATCH> -- e.g. v1.5.2. We adhere to semantic 
-versioning, so the MAJOR version changes when there are backwards-incompatible changes - e.g., you need to change the name of a frame you're using for it to keep working. The MINOR version changes when features are added but are backwards-compatible. The PATCH version changes when there are backwards-compatible bug fixes.
+The most straightforward way to view changes to the Lookit code is to review the 
+list of `commits <https://github.com/lookit/ember-lookit-frameplayer/commits/master>`__.
+If you're planning to update to the latest commit, you should read through the 
+pull request notes for each commit between the one you're using and the new one. 
 
 Update steps
 -----------------
 
 Here's how to update the code used:
 
-1. Click "Edit study" on the study you want to update.
+1. Click "Edit Study Design" on the study you want to update.
 
    .. image:: _static/img/update_code/edit_study.png
     :alt: Edit study button
 
-2. Scroll down to the "Experiment runner type" section. You should see a value in the  `Experiment runner version (commit SHA)`` field if you have built a preview or experiment runner before, like this:
+2. At the bottom of this page you should see a value in the 
+``Experiment runner version (commit SHA)`` field if you have built a preview or 
+experiment runner before, like this:
 
    .. image:: _static/img/update_code/initial_state.png
       :alt: Filled in sha value   
 
-   **Make a note of this value,** just in case the update makes something work differently in your study and you want to return to the current version.
+   **Make a note of this value,** just in case the update makes something work 
+   differently in your study and you want to return to the current commit.
 
-   You should see a bit of information about this version - the date, the message associated with the most recent change, and a list of files that were updated.
+   You should see a bit of information about this commit - the date, the message 
+   associated with the most recent change, and a list of files that were 
+   updated.
 
-3. We'll focus here on just updating the version of the central Lookit code you're using. You can also edit the ``Experiment runner code URL`` to use a different repository entirely, like your own fork. The steps are the same regardless of which repo you're using, but pointing to your own code is more advanced. 
+3. We'll focus here on just updating the commit of the Lookit frameplayer code 
+you're using. You can also edit the ``Experiment runner code URL`` to use a 
+different repository entirely, like your own fork. The steps are the same 
+regardless of which repo you're using, but pointing to your own code is more 
+advanced. 
 
-   **Option 1: latest version**: You can delete the value in ``Experiment runner version (commit SHA)`` and leave it blank to use the default value, which is the most recent version of the Lookit frameplayer code.
+   **Option 1: latest version**: You can delete the value in 
+   ``Experiment runner version (commit SHA)`` and leave it blank to use the 
+   default value, which is the most recent version of the Lookit frameplayer 
+   code.
 
    .. image:: _static/img/update_code/blank_sha.png
        :alt: Blank sha value to use default
 
-   **Option 2: specific version**: You can click "Check for updates" and then paste in the ID of the code version you want to use ("commit sha"). You can also copy a version from the `release list <https://github.com/lookit/ember-lookit-frameplayer/releases>`__. If you do this, click the button circled below to go to a page that shows the commit sha:
+   **Option 2: specific version**: You can click "Check for updates" and then 
+   paste in the SHA of the commit you want to use ("commit sha"). You can also 
+   copy the SHA from the 
+   `commits list <https://github.com/lookit/ember-lookit-frameplayer/commits/master>`__. 
+   If you do this, click the copy button next to the commit:
 
    .. image:: _static/img/update_code/commit_from_release.png
        :alt: Release notes and button to show commit sha
-
-   You can browse all commits by going to `<https://github.com/lookit/ember-lookit-frameplayer/commits/master>`__. If you do this, click the clipboard button (circled) to copy the commit sha.
-
-   .. image:: _static/img/update_code/commit_list.png
-       :alt: List of commits to master
 
-   By default you will see only commits to the "master" branch of the frameplayer. If you want to use the "develop" branch, where new changes are tested out initially, you can select it instead:
+   By default you will see only commits to the "master" branch of the 
+   frameplayer. If you want to use the "develop" branch, where new changes are 
+   tested out initially, you can select it instead:
 
    .. image:: _static/img/update_code/branch_list.png
        :alt: Dropdown menu of code branches
 
-   You can click on any commit for more detail about what was changed. From there you can also see the commit sha (circled).
+   You can click on any commit for more detail about what was changed. 
 
    .. image:: _static/img/update_code/commit_detail.png
        :alt: Detailed view of commit
 
-   Paste the commit sha you want to use into the study edit view, and you should see some information confirming it's the one you wanted:
+   Paste the commit sha you want to use into the study edit view, and you should 
+   see some information confirming it's the one you wanted:
 
    .. image:: _static/img/update_code/filled_sha.png
        :alt: Example sha value filled in
 
 
-4. Click "Save Changes". You will see a warning pop up if your study has already been approved, telling you it will be rejected automatically and require re-review. This is so that CHS staff can review any new code you're using (in particular if you're using your own repo).
+4. Click "Save Changes". You will see a warning pop up if your study has already 
+been approved, telling you it will be rejected automatically and require re-review. 
+This is so that CHS staff can review any new code you're using (in particular if 
+you're using your own repo).
 
    .. image:: _static/img/update_code/click_save.png
        :alt: Save button
@@ -78,23 +96,37 @@ Here's how to update the code used:
        :alt: Save warning
 
 
-5. Because the code you're using is different now, you will need to build a (new) experiment runner before you can start your study again. If you click the "Preview study" button on your main study page or edit study page, you will be taken to a preview of the "study detail" page participants see before deciding whether to start the study. But you won't have the option to actually preview the study yet:
+5. Because the code you're using is different now, you will need to build a 
+(new) experiment runner before you can start your study again. If you click the 
+"Preview study" button on your main study page or edit study page, you will be 
+taken to a preview of the "study detail" page participants see before deciding 
+whether to start the study. But you won't have the option to actually preview 
+the study yet:
 
    .. image:: _static/img/update_code/preview_detail_page.png
        :alt: Preview detail page without option to participate yet
 
-   Even if you are just updating to the latest version of the master branch, you should preview your study and make sure everything still works just how you want it to! Click "Build experiment runner" on your main study page:
+   Even if you are just updating to the latest version of the master branch, you
+   should preview your study and make sure everything still works just how you 
+   want it to! Click "Build experiment runner" on your main study page:
 
    .. image:: _static/img/update_code/build_preview.png
        :alt: Build preview runner button
 
-   Once you get an email notification that the experiment runner has been built, you will be able to try out your study. The preview detail page will now have a button to preview the study:
+   Once you get an email notification that the experiment runner has been built, 
+   you will be able to try out your study. The preview detail page will now have 
+   a button to preview the study:
 
    .. image:: _static/img/update_code/preview_enabled.png
        :alt: Preview detail page with option to participate
 
 
-6. If you were already collecting data, return to your main study page where you will probably see that its state is "rejected." Click "change state" and select "submit" to submit your study for re-approval. Once it is approved, you will be able to start data collection again. You will need to click "Build experiment runner" and wait for that process to complete (about ten minutes) before you can start the study.
+6. If you were already collecting data, return to your main study page where you 
+will probably see that its state is "rejected." Click "change state" and select 
+"submit" to submit your study for re-approval. Once it is approved, you will be 
+able to start data collection again. You will need to click "Build experiment 
+runner" and wait for that process to complete (about ten minutes) before you can 
+start the study.
 
    .. image:: _static/img/update_code/change_state.png
        :alt: Change study state