From: Guillaume Pellerin <guillaume.pellerin@ircam.fr>
Date: Thu, 8 Dec 2016 10:48:02 +0000 (+0100)
Subject: Update doc, add gulp port
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=9fd1c60f41f15362dab55dee001a887cafd04417;p=mezzo.git

Update doc, add gulp port
---

diff --git a/README.rst b/README.rst
index ffb20793..3bd4ef9a 100644
--- a/README.rst
+++ b/README.rst
@@ -2,15 +2,25 @@
 Mezzanine-organization
 ======================
 
-This application is a CMS for organizations with workflows
+Mezzanine-organization is a complete CMS for organizations with complex workflows
 
 It is based on Mezzanine_ and Django_.
 
 Use cases
 ==========
 
-...
+In fact any organization web site that needs a dedicated customable backend...
 
+Features
+========
+
+- Page, news and event management
+- Smart media management (video, audio, etc..)
+- Project data management including demo repositories
+- Activity management of person per department
+- Job candidancy forms
+- Full translation models
+- Fully dockerized for easy setup
 
 .. _Django : https://www.djangoproject.com/
 .. _Mezzanine : http://mezzanine.jupo.org/
@@ -204,14 +214,14 @@ Prod
 Development
 ===========
 
-Start in dev mode
-+++++++++++++++++
+Dev mode
++++++++++
 
 For a development environment setup::
 
     docker-compose -f docker-compose.yml -f env/dev.yml up
 
-Then browse the app at http://localhost:9020/
+This will launch the django development server. Then browse the app at http://localhost:9020/
 
 On MacOS or Windows, we need to replace 'localhost' by the IP given by the docker terminal.
 
@@ -237,13 +247,14 @@ Accessing the app container shell::
 Front
 +++++
 
-1. Installing gulp dependencies::
+The styles are written in SASS in app/static and the builder uses Gulp.
+All the builing tools are included in the app container so that you can build the front in one command::
 
-    See previous section: "Compile static files".
+    bin/build_font.sh
 
-2. Run gulp::
+To start the gulp server to get dynamic builing::
 
-    gulp
+    docker-compose run app gulp serve
 
 Gulp will launch BrowserSync. BrowserSync is a middleware that expose the website on port 3000.
 Any change on CSS or JS files will trigger the build system and reload the browser.
diff --git a/doc/src/development.rst b/doc/src/development.rst
index 1f54d012..2ccbc0e1 100644
--- a/doc/src/development.rst
+++ b/doc/src/development.rst
@@ -2,14 +2,14 @@
 Development
 ===========
 
-Start in dev mode
-+++++++++++++++++
+Dev mode
++++++++++
 
 For a development environment setup::
 
     docker-compose -f docker-compose.yml -f env/dev.yml up
 
-Then browse the app at http://localhost:9020/
+This will launch the django development server. Then browse the app at http://localhost:9020/
 
 On MacOS or Windows, we need to replace 'localhost' by the IP given by the docker terminal.
 
@@ -35,13 +35,14 @@ Accessing the app container shell::
 Front
 +++++
 
-1. Installing gulp dependencies::
+The styles are written in SASS in app/static and the builder uses Gulp.
+All the builing tools are included in the app container so that you can build the front in one command::
 
-    See previous section: "Compile static files".
+    bin/build_font.sh
 
-2. Run gulp::
+To start the gulp server to get dynamic builing::
 
-    gulp
+    docker-compose run app gulp serve
 
 Gulp will launch BrowserSync. BrowserSync is a middleware that expose the website on port 3000.
 Any change on CSS or JS files will trigger the build system and reload the browser.
diff --git a/doc/src/overview.rst b/doc/src/overview.rst
index 6fab3047..9fa69c6b 100644
--- a/doc/src/overview.rst
+++ b/doc/src/overview.rst
@@ -2,15 +2,25 @@
 Mezzanine-organization
 ======================
 
-This application is a CMS for organizations with workflows
+Mezzanine-organization is a complete CMS for organizations with complex workflows
 
 It is based on Mezzanine_ and Django_.
 
 Use cases
 ==========
 
-...
+In fact any organization web site that needs a dedicated customable backend...
 
+Features
+========
+
+- Page, news and event management
+- Smart media management (video, audio, etc..)
+- Project data management including demo repositories
+- Activity management of person per department
+- Job candidancy forms
+- Full translation models
+- Fully dockerized for easy setup
 
 .. _Django : https://www.djangoproject.com/
 .. _Mezzanine : http://mezzanine.jupo.org/
diff --git a/env/dev.yml b/env/dev.yml
index 4eedc10c..0af15322 100644
--- a/env/dev.yml
+++ b/env/dev.yml
@@ -25,5 +25,6 @@ app:
     - ./app/:/srv/app
   ports:
     - "9020:8000"
+    - "3000:3000"
   environment:
     - DEBUG=True