DOCS

docs/about.md

 
-##Welcome to Gargantext documentation
 

docs/automatic_install.md

+#

docs/contribution-guide.md

+#Contribution guide
+
+## Community
+* [http://gargantext.org/about](http://gargantext.org/about)
+* IRC Chat: (OFTC/FreeNode) #gargantex
+
+##Tools
+* gogs
+* server access
+* forge
+* gargantext box
+
+##Gargantex
+* Gargantex box install
+
+(S.I.R.= Setup Install & Run procedures)
+
+* Architecture Overview
+
+
+* Database Schema Overview
+
+* Interface design Overview
+
+##To do:
+* Docs
+* Interface deisgn
+* Parsers/scrapers
+* Computing
+
+## How to contribute:
+    1. Clone the repo
+    2. Create a new branch <username>-refactoring
+    3. Run the gargantext-box
+    4. Code
+    5.Test
+    6. Commit
+
+### Exemple1: Adding a parser
+* create your new file cern.py into gargantex/scrapers/
+
+* reference into gargantex/scrapers/urls.py
+add this line:
+import scrapers.cern  as cern
+
+* reference into gargantext/constants
+```
+# type 9
+    {   'name': 'Cern',
+        'parser': CernParser,
+        'default_language': 'en',
+    },
+```
+* add an APIKEY in gargantex/settings
+
+
+### Exemple2: User Interface Design

docs/index.md

-#Gargantext
 
-Welcome to Garagentext documentation!
+
+Gargantext is a web plateform to explore your corpora using text-mining[...](about.md)
+
+## Getting started
+
+* [Install](install.md) the Gargantext box
+
+* [Take a tour](demo.md) of the different features offered by Gargantext
+
+##Need some help?
+
+Ask the community at:
+
+* [http://gargantext.org/about](http://gargantext.org/about)
+* IRC Chat: (OFTC/FreeNode) #gargantex
+
+##Want to contribute?
+
+* take a look at the [architecture overview](overview.md)
+* read the [contribution guide](contribution-guide.md)
+
+
+## News
+
+## Credits and acknowledgments

docs/install.md

-Gargantext
-===========
-
 Install Instructions for Gargantext (CNRS):
 
-=> Help needed ?
+Help needed ?
 See [http://gargantext.org/about](http://gargantext.org/about) and [tools]() for the community
 
-1. [SETUP](##SETUP)
-2. [INSTALL](##INSTALL)
-*.1 with [docker](####DOCKER) [EASY]
-*.2 with [debian](####DEBIAN) [EXPERT]
-
-3. [RUN](##RUN)
 
+Prepare your environnement and make the initial installation.
+Once you setup and install the Gargantext box. You can use ./install/run.sh utility
+to load gargantext web plateform and access it throught your web browser
 
-##SETUP
-Prepare your environnement
+______________________________
 
-* Create user gargantua
-Main user of Gargantext is Gargantua (role of Pantagruel soon)!
+1. [Prerequisites](##Prerequisites)
 
-``` bash
-sudo adduser --disabled-password --gecos "" gargantua
-```
+2. [SETUP](##Setup)
 
-* Create the directories you need
+3. [INSTALL](##Install)
 
-``` bash
-for dir in "/srv/gargantext"
-           "/srv/gargantext_lib"
-           "/srv/gargantext_static"
-           "/srv/gargantext_media"
-           "/srv/env_3-5"; do
-    sudo mkdir -p $dir ;
-    sudo chown gargantua:gargantua $dir ;
-done
-```
+4. [RUN](##RUN)
+______________________________
+##Prerequisites
 
-You should see:
+* A Debian based OS >= [FIXME]
 
-```bash
-$tree /srv
-/srv
-├── gargantext
-├── gargantext_lib
-├── gargantext_media
-│   └── srv
-│       └── env_3-5
-├── gargantext_static
-└── lost+found [error opening dir]
+* At least 35GO in the desired location of Gargantua [FIXME]
+    todo: reduce the size of gargantext lib
+    todo: remove lib once docker is configure
 
-```
-* Get the main libraries
+    tip: if you have enought space for the full package you can:
+        * resize your partition
+        * make a simlink on gargantext_lib
 
-``` bash
-wget http://dl.gargantext.org/gargantext_lib.tar.bz2 \
-&& tar xvjf gargantext_lib.tar.bz2 -o /srv/gargantext_lib \
-&& sudo chown -R gargantua:gargantua /srv/gargantext_lib \
-&& echo "Libs installed"
-```
+* A [docker engine installation](https://docs.docker.com/engine/installation/linux/)
 
-* Get the source code of Gargantext
+##Setup
+Prepare your environnement and make the initial setup.
 
-by cloning the repository of gargantext
-``` bash
-git clone ssh://gitolite@delanoe.org:1979/gargantext /srv/gargantext \
-        && cd /srv/gargantext \
-        && git fetch origin refactoring \
-        && git checkout refactoring \
-```
+Setup can be done in 2 ways:
+    * [automatic setup](setup.sh) can be done by using the setup script provided [here](setup.sh)
+    * [manual setup](manual_setup.md) if you want to change some parameters [here](manual_setup.md)
 
-    TODO(soon): git clone https://gogs.iscpif.fr/gargantext.git
-    TODO(soon): install/setup.sh
+##Install
 
-* **Optionnal**: if you want to contribute clone the repo into your own branch
-
-``` bash
-git checkout -b username-refactoring refactoring
-```
-
-
-##INSTALL
-Build your OS dependencies
-2 ways, for each you need to install Debian GNU/Linux dependencies.
+Two installation procedure are actually proposed:
+* the docker way [easy]
+* the debian way [advanced]
 
 ####DOCKER WAY [EASY]
 
@@ -94,6 +55,7 @@ See [installation instruction for your distribution](https://docs.docker.com/eng
 ``` bash
 cd /srv/gargantext/install/docker/dev
 ./build
+ID=$(docker build .) && docker run -i -t $ID
 ```
 
 You should see
@@ -126,12 +88,6 @@ exit (or Ctrl+D)
 ```
 
 
-####DEBIAN way [EXPERT]
-
-[EXPERTS] Debian way (directory install/debian)
-
-
-
 Install Gargantext server
 
 * Enter docker container
@@ -159,10 +115,15 @@ python /srv/gargantext/dbmigrate.py
 
     FIXME: dbmigrate need to launched several times since tables are
     ordered with alphabetical order (and not dependencies order)
+####Debian way [advanced]
 
-##RUN
+##Run Gargantext
 * Launch Gargantext
 
+Enter the docker container:
+``` bash
+/srv/gargantext/install/docker/enterGargantextImage
+```
 Inside the docker container:
 ``` bash
 #start postgresql
@@ -190,6 +151,6 @@ Login : gargantua
 Password : autnagrag
 ```
 Enjoy :)
-See [User Guide](./tuto.md) for quick usage example
+See [User Guide](/demo/tuto.md) for quick usage example
 
 

docs/manual_install.md

+* Create user gargantua
+Main user of Gargantext is Gargantua (role of Pantagruel soon)!
+``` bash
+sudo adduser --disabled-password --gecos "" gargantua
+```
+
+* Create the directories you need
+
+here for the example gargantext package will be installed in /srv/
+``` bash
+for dir in "/srv/gargantext"
+           "/srv/gargantext_lib"
+           "/srv/gargantext_static"
+           "/srv/gargantext_media"
+           "/srv/env_3-5"; do
+    sudo mkdir -p $dir ;
+    sudo chown gargantua:gargantua $dir ;
+done
+```
+
+You should see:
+
+```bash
+$tree /srv
+/srv
+├── gargantext
+├── gargantext_lib
+├── gargantext_media
+│   └── srv
+│       └── env_3-5
+└── gargantext_static
+```
+* Get the main libraries
+
+Download uncompress and make main user access to it.
+PLease, Be patient due to the size of the packages libraries (27GO)
+this step can be long....
+
+``` bash
+wget http://dl.gargantext.org/gargantext_lib.tar.bz2 \
+&& tar xvjf gargantext_lib.tar.bz2 -o /srv/gargantext_lib \
+&& sudo chown -R gargantua:gargantua /srv/gargantext_lib \
+&& echo "Libs installed"
+```
+
+* Get the source code of Gargantext
+
+by cloning the repository of gargantext
+``` bash
+git clone ssh://gitolite@delanoe.org:1979/gargantext /srv/gargantext \
+        && cd /srv/gargantext \
+        && git fetch origin refactoring \
+        && git checkout refactoring \
+```
+
+    TODO(soon): git clone https://gogs.iscpif.fr/gargantext.git
+
+
+See the [next steps of installation procedure](install.md#Install)

docs/overview.md

+#Architecture Overview
+#Database Schema
+#Website