Upadetes the readme..
authorymh <ymh.work@gmail.com>
Sun, 24 Jun 2018 03:39:26 +0200
changeset 18 a8b07497ae4b
parent 17 5b6aa12feaed
child 19 b6b9e9635cec
Upadetes the readme..
README.md
sbin/sync/README.md
--- a/README.md	Sun Jun 24 02:25:12 2018 +0200
+++ b/README.md	Sun Jun 24 03:39:26 2018 +0200
@@ -114,9 +114,9 @@
 
 ### Elasticsearch
 
-Some objects in Iconolab are indexed and searched using ElasticSearch. You need to configure Haystack (see dev.py.tmpl, HAYSTACK_CONNECTIONS) and run:
+Some objects in Iconolab are indexed and searched using ElasticSearch. You need to configure the elasticsearch parameters (see dev.py.tmpl, ELASTICSEARCH_DSL) and run:
 
-    python manage.py rebuild_index
+    python manage.py search_index --rebuild
 
 
 ### 2. Python server
@@ -178,4 +178,15 @@
 - ```--collection-id```: the id of the collection to import into, it must already exist
 
 
- * document the test import command  : `python manage.py importimages --collection-json dossierImportMontauban/montauban_collection.json --metacategories-json dossierImportMontauban/montauban_metacategories_import.json --encoding "UTF-8" --delimiter "," dossierImportMontauban/ExportMontauban.csv`
\ No newline at end of file
+ * document the test import command  : `python manage.py importimages --collection-json dossierImportMontauban/montauban_collection.json --metacategories-json dossierImportMontauban/montauban_metacategories_import.json --encoding "UTF-8" --delimiter "," dossierImportMontauban/ExportMontauban.csv`
+
+
+### defining a new version
+
+To define a new version, the following steps must be taken.
+* if needed, refresh the `iconolab` version number in `src/setup.py`, in the key `install_requires`.
+* check that the matching tag has been published in the `iconolab` mercurial repository.
+* Update the version number in `src/iconolab_mcc/__init__.py`
+* Create a mercurial tag that matches the new version number
+* push the new commits and tag
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sbin/sync/README.md	Sun Jun 24 03:39:26 2018 +0200
@@ -0,0 +1,42 @@
+# Deployement scripts for ICONOLAB-MCC 
+
+Theses scripts uses `fabric` 2.X.
+
+  * create a virtualenv
+  * `$ pip install -r resquirements.txt`
+
+## Configuration
+
+The scripts are configured in the `fabric.py` file
+  * ` cp fabric.py.tmpl fabric.py`
+  * edit the file to match the expected configuration
+
+## Tasks
+the following task has been defined:
+
+  - create-virtualenv
+  - publish-version
+  - relaunch-server
+
+### relaunch-server
+
+Usage: `$ fab relaunch-server`
+Description: relaunch the webservices after calling the following commands on the server:
+  * `django-admin migrate`
+  * `django-admin collectstatic`
+
+### create-virtualenv
+
+Usage: `$ fab create-virtualenv <hg_tags>`
+Description: Create a virtualenv on the server with the new application version and the matching requirements. This deletes the previous virtualenv first.
+Please note that this command only creates the virtualenv. It does not create the full setup for the application :
+  * the settings file,
+  * the applications orchestration scripts,
+  * the application folders
+
+### publish-version
+
+Usage: `$ fab publish-version <hg_tags>`
+Description: publish the given version of the website. It calls the following commands:
+  * `create-virtualenv <hg_tags>`
+  * `relaunch-server`