Started doc

Author: qcoumes

docs/.readthedocs.yml

@@ -0,0 +1 @@
+requirements_file: requirements.txt

2019:02:19CR.md docs/2019:02:19CR.md

@@ -0,0 +1,34 @@
+[![Build Status](https://travis-ci.org/PremierLangage/wims-lti.svg?branch=master)](https://travis-ci.org/PremierLangage/wims-lti)
+[![codecov](https://codecov.io/gh/PremierLangage/wims-lti/branch/master/graph/badge.svg)](https://codecov.io/gh/PremierLangage/wims-lti)
+[![GPLv3](https://img.shields.io/badge/license-GPLv3-brightgreen.svg)](#)
+
+
+# Introduction
+
+**WIMS-LTI** is a gateway server that links a *LMS* to a *WIMS* server, using *LTI*.
+
+**WIMS-LTI** allows :
+
+* To create a *WIMS* class associated to a *LMS*' course.
+* To create students corresponding to that course in the *WIMS* class.
+* The students to connect to the *WIMS* server from the *LMS*.
+* The teachers to connect to the *WIMS* class as supervisor or as students.
+* To send the grades of students back to the LMS.
+
+
+## How does it work ?
+
+Once **WIMS-LTI** is installed and running, it is possible to add *LMS* and *WIMS* server
+from the administration panel, each WIMS server having a list of authorized LMS.
+
+Teacher will then be able to go on `[server]/lti/links/` to get the URL that should be
+paste on the LMS.
+
+There is two kinds of URL:
+
+* Class URL : Create a new class and redirect to the class' home on WIMS the first time it is
+    clicked on from a LMS, only redirect to the class' home on subsequent click. It will also create
+    a corresponding user on the WIMS user if needed.
+* Activity URL : Will redirect an user to the corresponding worksheet, creating the user if needed.
+    If someone with a role of Teacher click on this link, it will also send every grade of the
+    corresponding sheet to the LMS.

docs/LICENSE.md

@@ -0,0 +1,96 @@
+# Installation
+
+## Dependencies
+
+* Python 3.5+
+* pip3
+* Apache2 & mod_wsgi
+
+
+First, you need to clone the repositoy:
+
+```bash
+git clone https://openproject.u-pem.fr/git/wims-lti.git
+cd wims-lti
+```
+Then, you have to edit `wimsLTI/config.py` to change some default parameters, 
+see [Parameters reference](https://docs.djangoproject.com/fr/2.1/ref/settings/).
+First, it's important to set `DEBUG = False` and to modify:
+[`SECRET_KEY`](https://docs.djangoproject.com/fr/2.1/ref/settings/#std:setting-SECRET_KEY) et
+[`ALLOWED_HOSTS`](https://docs.djangoproject.com/fr/2.1/ref/settings/#allowed-hosts).
+
+Once parameter correctly defined, then launch the installation script.
+It will ask for a user name, an email address, and a password to create
+an administration account.
+
+***Careful: If you are using a [python environment](https://docs.python.org/fr/3/tutorial/venv.html),
+remember to use it.***
+
+```bash
+./install.sh
+```
+
+Now, you only have to configure *Apache*,
+see [the documentation](https://docs.djangoproject.com/fr/2.1/howto/deployment/wsgi/modwsgi/).
+
+## Configuration
+
+### WIMS side
+
+In order to have the *WIMS* server to accept **WIMS-LTI** requests, you have to create
+a connection file. The creation of this file is explained 
+[here](https://wimsapi.readthedocs.io/#configuration)
+
+It is important to add the IP address of the **WIMS-LTI gateway** to the 
+`ident_site` key and not the ip of the *LMS*
+Remember the value of the `ident_password` and the name of the created file,
+you will need these to add the server to **WIMS-LTI**.
+
+
+### WIMS-LTI side
+
+1. Connect to `[WIMS-LTI SERVEUR]/admin/` and enter the administration 
+account login and password that you got when you installed the server.
+
+2. Click on `wims` (or go to `[WIMS-LTI SERVEUR]/admin/wims/wims/`)
+
+3. Click `ADD WIMS` in the top left, and fill the form:
+    * `DNS` : DNS of the *WIMS* server, ex: `wims.unice.fr`.
+    * `URL` : URL of the *WIMS* server CGI, ex: `https://wims.unice.fr/wims/wims.cgi`.
+    * `Name` : Name to identify the *WIMS* server, ex: `WIMS UNICE`.
+    * `Ident` : Name of the connection file created on the *WIMS* server. 
+                For example, if the file created was `[WIMS_HOME]/log/classes/.connections/myself`,
+                enter `myself`.
+    * `Passwd` : Value of the key `ident_password` of the configuration file *Ident*.
+    * `Rclass` : Identifiers used by *WIMS-LTI* to create classes on the *WIMS* server,
+                 for example: `myclass`.
+    
+    Repeat ***3.*** for each *WIMS* server that you want to add.
+
+4. Go back to `[WIMS-LTI SERVEUR]/admin/` and click on `LMS` (or go to 
+`[WIMS-LTI SERVEUR]/admin/wims/lms/`)
+
+5. Click `ADD LMS` in the top left and fill the form:
+    * `UUID` : UUID of the *LMS* corresponding to the `tool_consumer_instance_guid` parameter
+               of the LTI request. Most of the time, it is the DNS of the *LMS*.
+               For example: `elearning.u-pem.fr`
+    * `Name` : Name that identifies the *LMS*, for example: `Moodle UPEM`.
+    * `URL` : URL of the *LMS*, for example: `https://elearning.u-pem.fr/`
+    
+    Repeat ***5.*** for each *LMS* that you want to add.
+
+
+___
+
+It is now possible to connect to any *WIMS* server added, from any *LMS* added, thanks to the URLs.
+
+* `[WIMS-LTI SERVEUR]/dns/[WIMS DNS]/` -
+  for example : `https://wims-lti.u-pem.fr/dns/wims.u-pem.fr/`
+
+ou
+
+* `[WIMS-LTI SERVEUR]/dns/[WIMS ID]/` - where `WIMS ID` is the ID of the *WIMS* server
+  in the **WIMS-LTI** database,
+  for example : `https://wims-lti.u-pem.fr/id/0/`
+
+The list of the URLs can be found on the page `[WIMS-LTI SERVEUR]/list/`

docs/index.md

@@ -0,0 +1 @@
+mkdocs==1.0.4

docs/installation.md

@@ -22,16 +22,14 @@ echo "pip3: OK !"
 command -v git >/dev/null 2>&1 || { echo >&2 "ERROR: git should be installed"; exit 1; }
 echo "git: OK !"
 
-
-
 # Making sure changes to wimsLTI/config.py are not pushed
 git update-index --no-skip-worktree wimsLTI/config.py
 
 
 
 # Checking if inside a python venv
 if [ "$VIRTUAL_ENV" == "" ]; then
-    echo ""
+    echo
     INVENV=1
     echo "WARNING: We recommend you to use a python virtual environment (https://docs.python.org/3/library/venv.html)." | fold -s
     read -p "Do you want to continue outside a virtual environment ? [Y/n] " -n 1 -r
@@ -45,7 +43,7 @@ fi
 
 
 # Getting requirement
-echo ""
+echo
 echo "Installing requirements..."
 pip3 install wheel  || { echo>&2 "ERROR: pip3 install wheel failed" ; exit 1; }
 pip3 install -r requirements.txt || { echo>&2 "ERROR: pip3 install -r requirements.txt failed" ; exit 1; }
@@ -54,12 +52,18 @@ echo "Done !"
 
 
 # Building database
-echo ""
+echo
 echo "Configuring database..."
 python3 manage.py makemigrations || { echo>&2 "ERROR: python3 manage.py makemigrations failed" ; exit 1; }
 python3 manage.py migrate || { echo>&2 "ERROR: python3 manage.py migrate failed" ; exit 1; }
-python3 manage.py collectstatic || { echo>&2 "ERROR: python3 manage.py collectstatic failed" ; exit 1; }
+echo "Done !"
+
 
+# Collecting statics
+echo
+echo "Collecting statics..."
+python3 manage.py collectstatic || { echo>&2 "ERROR: python3 manage.py collectstatic failed" ; exit 1; }
+echo "Done !"
 
 
 # Creating super user
@@ -73,4 +77,4 @@ then
     python3 manage.py createsuperuser || { echo>&2 "ERROR: python3 manage.py createsuperuser failed" ; exit 1; }
 fi
 
-echo "Run 'python3 manage.py createsuperuser' to create super users in the future."
+echo "Run 'python3 manage.py createsuperuser' to create superusers in the future."

docs/requirements.txt

@@ -0,0 +1,12 @@
+site_name: WIMS-LTI Documentation
+site_author: Quentin Coumes
+repo_url: https://github.com/PremierLangage/wims-lti/
+
+nav:
+  - Introduction: index.md
+  - Installation: installation.md
+  - Configuration: configuration.md
+  - License: LICENSE.md
+  - Github: https://github.com/PremierLangage/wims-lti/
+
+theme: readthedocs