From ed68c2cb3889e997645cae2e1a314c91ffc518c0 Mon Sep 17 00:00:00 2001 From: Bartuccio Antoine Date: Wed, 14 Aug 2019 15:21:43 +0200 Subject: [PATCH] documentation: move documentation about usage in production --- README.rst | 18 ------------------ doc/index.rst | 1 + doc/misc/prod.rst | 21 +++++++++++++++++++++ 3 files changed, 22 insertions(+), 18 deletions(-) create mode 100644 doc/misc/prod.rst diff --git a/README.rst b/README.rst index 6099f669..bec0058a 100644 --- a/README.rst +++ b/README.rst @@ -34,24 +34,6 @@ Sith AE This project is licenced under GNU GPL, see the LICENSE file at the top of the repository for more details. -Logging errors with sentry --------------------------- - -To connect the app to sentry.io, you must set the variable SENTRY_DSN in your settings custom. It's composed of the full link given on your sentry project - -Collecting statics for production: ----------------------------------- - -We use scss in the project. In development environment (DEBUG=True), scss is compiled every time the file is needed. For production, it assumes you have already compiled every files and to do so, you need to use the following commands : - -.. sourcecode:: bash - - ./manage.py collectstatic # To collect statics - ./manage.py compilestatic # To compile scss in those statics - -Misc about development ----------------------- - Controlling the rights ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/index.rst b/doc/index.rst index 97357eb0..0724d75f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,6 +40,7 @@ Bienvenue sur la documentation du Sith de l'AE misc/md_syntax misc/helpers + misc/prod Documentations complémentaires ------------------------------ diff --git a/doc/misc/prod.rst b/doc/misc/prod.rst new file mode 100644 index 00000000..b628c28f --- /dev/null +++ b/doc/misc/prod.rst @@ -0,0 +1,21 @@ +Configurer pour la production +============================= + +Configurer Sentry +----------------- + +Pour connecter l'application à une instance de sentry (ex: https://sentry.io) il est nécessaire de configurer la variable **SENTRY_DSN** dans le fichier *settings_custom.py*. Cette variable est composée d'un lien complet vers votre projet sentry. + +Récupérer les statiques +--------------------- + +Nous utilisons du SCSS dans le projet. En environnement de développement (DEBUG=True), le SCSS est compilé à chaque fois que le fichier est demandé. Pour la production, le projet considère que chacun des fichier est déjà compilé, et, pour ce faire, il est nécessaire d'utiliser les commandes suivantes dans l'ordre : + +.. code-block:: bash + + ./manage.py collectstatic # Pour récupérer tous les fichiers statiques + ./manage.py compilestatic # Pour compiler les fichiers SCSS qu'ils contiennent + +.. note:: + + Le dossier où seront enregistrés ces fichiers statiques peut être changé en modifiant la variable *STATIC_ROOT* dans les paramètres. \ No newline at end of file