Merge commit 'a90e87b1be8f278113b191816e88ad6619bf3101' into 111_exports_suite

docs/source/installation/index.rst

@@ -14,6 +14,13 @@
 Installation & Usage
 ####################
 
+.. toctree::
+   :maxdepth: 2
+
+   prod.rst
+   prod-calendar-sms-sending.rst
+   msgraph-configure.rst
+
 
 Requirements
 ************
@@ -46,6 +53,35 @@ Clone or download the chill-skeleton project and `cd` into the main directory.
 
 As a developer, the code will stay on your computer and will be executed in docker container. To avoid permission problem, the code should be run with the same uid/gid from your current user. This is why we get your current user id with the command ``id -u`` in each following scripts.
 
+2. Prepare composer to download the sources
+===========================================
+
+As you are running in dev, you must configure an auth token for getting the source code.
+
+.. warning
+
+   If you skip this part, the code will be downloaded from dist instead of source (with git repository). You will probably replace the source manually, but the next time you will run ```composer update```, your repository will be replaced and you might loose something.
+
+1. Create a personal access token from https://gitlab.com/-/profile/personal_access_tokens, with the `read_api` scope.
+2. add a file called ```.composer/auth.json``` with this content:
+
+   .. code-block:: json
+
+      {
+        "gitlab-token": {
+            "gitlab.com": "glXXX-XXXXXXXXXXXXXXXXXXXX"
+        }
+      }
+
+2. Prepare your variables and environment
+=========================================
+
+Copy ```docker-compose.override.dev.yml``` into ```docker-compose.override.yml```
+
+.. code-block:: bash
+
+   cp docker-compose.override.dev.template.yml docker-compose.override.yml
+
 2. Prepare your variables and docker-compose
 ============================================
 
@@ -136,30 +172,6 @@ The password is always ``password``.
 
 Now, read `Operations` below.
 
-Prepare for development
-***********************
-
-Add a Gitlab token to ensure that you get always the source code:
-
-1. generate a gitlab token there: https://gitlab.com/oauth/token
-2. run this command (in php container, at the app's root): :code:`composer config gitlab-token.gitlab.com <your token>`
-
-   The auth token should appears now in the directory :code:`.composer`:
-
-   .. code-block: bash
-
-      $ cat .composer/auth.json
-      {
-          "gitlab-token": {
-              "gitlab.com": "<your token>"
-          }
-      }
-3. run ``composer update`` again (into the php container)
-
-
-
-See also "how to switch branch and get new dependencies".
-
 
 Operations
 **********
@@ -278,10 +290,14 @@ How to switch the branch for chill-bundles, and get new dependencies
 
 During development, you will switch to new branches for chill-bundles. As long as the dependencies are equals, this does not cause any problem. But sometimes, a new branch introduces a new dependency, and you must download it.
 
+.. warning::
+
+   Ensure that you have gitlab-token ready before updating your branches. See above.
+
 In order to do that without pain, use those steps:
 
 0. Ensuire you have a token, set
-1. at the app's root, update the `composer.json` to your current branch:
+1. at the app's root, update the ``composer.json`` to your current branch:
 
 .. code-block:: json
 
@@ -290,7 +306,7 @@ In order to do that without pain, use those steps:
           "chill-bundles": "dev-<my-branch>@dev"
    }
 
-2. mount into the php container, and run `composer update`
+2. mount into the php container (``./docker-php.sh``), and run ``composer update``
 
 Error `An exception has been thrown during the rendering of a template ("Asset manifest file "/var/www/app/web/build/manifest.json" does not exist.").` on first run
 ====================================================================================================================================================================