Merge pull request #288 from lookit/update-edit-study-form-fields

Update docs on study edit form and lab images
lookit · Jan 30, 2023 · 3479601 · 3479601
2 parents 6c5ecd8 + 7232df9
commit 3479601
Show file tree

Hide file tree

Showing 9 changed files with 121 additions and 77 deletions.
diff --git a/docs/source/_static/img/labs/demo_lab_badge_example.png b/docs/source/_static/img/labs/demo_lab_badge_example.png
diff --git a/docs/source/_static/img/labs/demo_lab_banner_example.png b/docs/source/_static/img/labs/demo_lab_banner_example.png
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
@@ -60,7 +60,7 @@ you want:
 
 -  You'll likely need to write a translation file for your language for the components 
    in the studies - e.g., consent, setup. Once that's available, you can specify a 
-   language for your study and any hard-coded text will be translated. (See :ref:`elf-translations`.)
+   language for your study and any hard-coded text will be translated. (See the experiment runner's :ref:`language parameter<elf:translation>`.)
 
 -  We haven’t currently set up to flag which language a study is in and
    let participants filter (or get the right version of a study) by

diff --git a/docs/source/publications.rst b/docs/source/publications.rst
@@ -2,7 +2,7 @@
 Publications
 ==================================
 
-.. _Training:
+.. _Publications:
 
 ---------------------------------------
 Publications using Lookit data

diff --git a/docs/source/researchers-manage-org.rst b/docs/source/researchers-manage-org.rst
@@ -84,13 +84,28 @@ Whether to make most lab members "guests" vs. "full members" is just a matter of
 
 By design, there is no way to give anyone access to participant data for all studies in your lab. You have to give them permission to individual studies. 
 
+.. _lab_custom_url:
+
 --------------------------------------------------------
 Lab's custom URL
 --------------------------------------------------------
 
 Each lab has its own page on Lookit. This provides a convenient URL for you to distribute and allows families to easily find all of your lab's active studies. To find the current custom URL for your lab, go to "Manage Labs" and select your lab. You will find the link to the lab's page under "Custom URL".
 
-To change your lab's URL, click "Edit lab" in the top right of your lab's information page. Update the "Custom URL" to suit your lab's preferences.  
+To change your lab's URL, click "Edit lab" in the top right of your lab's information page. Update the "Custom URL" to suit your lab's preferences.
+
+When creating and editing your lab details, you have the option to add a banner and/or badge image. If you upload a banner image, it will be shown at the top of your lab's custom page in place of the lab name (so you'll probably want to add your lab name to the image). The banner image should have a width-to-height ratio of at least 2. 
+
+.. image:: _static/img/labs/demo_lab_banner_example.png
+    :alt: Demo Lab page with wide banner image
+
+If you do not upload a banner image, then the badge image will be shown next to the lab name. The badge image dimensions must be square. Please keep each file size to less than 1 MB.
+
+.. image:: _static/img/labs/demo_lab_badge_example.png
+    :alt: Demo Lab page with square badge image
+
+.. note::
+    As part of future updates to the site to make it more mobile-friendly, the banner and badge images will both be used. In the future, the banner image will be shown at the top of your lab's custom page when the page is viewed on a wide (desktop/laptop) browser window, and the badge image will be shown when the page is viewed on a narrow browser window, such as on a mobile device.
 
 --------------------------------------------------------
 Ordering studies on your lab page

diff --git a/docs/source/researchers-set-study-fields.rst b/docs/source/researchers-set-study-fields.rst
diff --git a/docs/source/tutorial-contributing.rst b/docs/source/tutorial-contributing.rst
@@ -274,6 +274,8 @@ List of tutorial participants
 - Ashley Turell (University of Wisconsin) 
 - Milana Korobko (University of Pennsylvania)
 
+.. _Github issues:
+
 Checking for and creating issues on Github
 -------------------------------------------
 

diff --git a/docs/source/tutorial-manage-data.rst b/docs/source/tutorial-manage-data.rst
@@ -74,7 +74,7 @@ At that point, you will "submit" your study for approval by Lookit staff. We won
    From a participant's standpoint, Lookit is a unified platform, even though there are studies from a variety of research labs. This is great for participant recruitment! But it also means we're all sharing a reputation. Someone else's study that upsets or (without adequate precautions) deceives children, that baffles parents, or that just doesn't work will affect how interested families are in your study, too. Based on our early experience with researchers using Lookit, we strongly expect that a quick review will catch substantive issues often enough to be worth putting everyone through. If you are making changes to an existing study, review is either not required (if only changing certain fields like the age range/eligibility criteria) or is very quick.
 
 Create some data to play with (Internal studies)
---------------------------------
+--------------------------------------------------------
 
 Because we don't want to clog up the production server with fake responses from researchers trying out Lookit, we'll do this section on the staging server, which is a separate sandbox environment that looks a lot like Lookit but doesn't have any real participant data. This is also where we try out new features before deploying them to production. 
 
@@ -236,4 +236,4 @@ Returning to your "message participants" tab, let's create another email. This t
 
 Like before, paste in your ID, write your message, send it, and make sure you receive it. (Don't actually send yourself a gift card. Unless you really want to.)
 
-Congratulations! We've covered all the basic functionality you'll need to manage your studies. Finally, we'll wrap up by briefly noting some of the advanced features you might want to use later and revisiting Github issues now that you may have some feature requests or bug reports.
+Congratulations! We've covered all the basic functionality you'll need to manage your studies. Finally, we'll wrap up by briefly noting some of the advanced features you might want to use later and revisiting :ref:`Github issues<Github issues>` now that you may have some feature requests or bug reports.
diff --git a/docs/source/tutorial-next-steps.rst b/docs/source/tutorial-next-steps.rst
@@ -17,7 +17,7 @@ Let's practice that now. First, think of either a problem you encountered or som
 - The  `Lookit platform <https://github.com/lookit/lookit-api/issues>`_, including login/account system and the experimenter inferface (study management, data viewing/download, consent coding, participant messaging, etc.)
 - The `frameplayer <https://github.com/lookit/ember-lookit-frameplayer/issues>`_, including what frames are available to you to use in designing your studies and how they function
 
-:ref:`Review the section on Github issues<Github issues overview>` and click the appropriate link above to view the current issue list. Either create a new issue if your idea/problem isn't already described, or comment on an existing issue!
+:ref:`Review the section on Github issues<Github issues>` and click the appropriate link above to view the current issue list. Either create a new issue if your idea/problem isn't already described, or comment on an existing issue!
 
 2. Some advanced options to be aware of
 ---------------------------------------