Skip to content

Commit

Permalink
technical glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
Mayowa99 committed Aug 14, 2019
1 parent 40833b3 commit 7a35af8
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 44 deletions.
48 changes: 46 additions & 2 deletions docs/source/Technical-Glossary.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Technical Glossary
~~~~~~~~~~~~~~~~~~~
.. _Technical_glossary:

===================
Technical Glossary
===================



Internal Resources
___________________
Docker
------

Expand Down Expand Up @@ -121,6 +125,46 @@ a dummy link for this purpose and then send the video from this dummy address to






External Resources
___________________

Google Cloud
-------------

The Cloud service is where all the studies are stored.


Amazon Web Services
--------------------

This is where the consent videos are stored??

Celery
-------

This is what runs the long term tasks

Authenticator
---------------

Allows you to log into your account securely

Lookit Ember Frameplayer
------------------------

Consent manager videos

ADDPIPE
-------

ADDPIPE is used to record the video and audio. It connects to the hardware of your computer and films for you. It also
converts recorded files to ,mp4. https://addpipe.com/about



Footnotes
----------

Expand Down
43 changes: 1 addition & 42 deletions docs/source/api-main-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Lookit API Local Machine Setup
Prerequisites
~~~~~~~~~~~~~
Before you can get the API running on your machine, there are a few steps you need to take to ensure everything will work
properly.
properly. Information about these programs can be found in the :ref:`Technical_glossary`

Install Docker
--------------
Expand Down Expand Up @@ -124,11 +124,6 @@ To connect to your local host run this command:



Install SSL Certificates
------------------------



Setup
~~~~~

Expand All @@ -137,40 +132,7 @@ Setup



External Resources
~~~~~~~~~~~~~~~~~~~

Google Cloud
-------------

The Cloud service is where all the studies are stored.


Amazon Web Services
--------------------

This is where the consent videos are stored??

Celery
-------

This is what runs the long term tasks

Authenticator
---------------

Allows you to log into your account securely

Lookit Ember Frameplayer
------------------------

Consent manager videos

ADDPIPE
-------

ADDPIPE is used to record the video and audio. It connects to the hardware of your computer and films for you. It also
converts recorded files to ,mp4. https://addpipe.com/about

How Do These Programs Work Together?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -196,9 +158,6 @@ When you want to build a study, celery sends that request to Docker, which then
After building the study, celery sends deployable static files to Google Cloud.





.. image:: _static/img/use-case.png

This is a diagram of all interactions possible with the Lookit API. On the rightmost side are all external resources being
Expand Down

0 comments on commit 7a35af8

Please sign in to comment.