documentation: move documentation about usage in production

This commit is contained in:
Antoine Bartuccio 2019-08-14 15:21:43 +02:00
parent a6c8dea190
commit ed68c2cb38
Signed by: klmp200
GPG Key ID: E7245548C53F904B
3 changed files with 22 additions and 18 deletions

View File

@ -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
~~~~~~~~~~~~~~~~~~~~~~

View File

@ -40,6 +40,7 @@ Bienvenue sur la documentation du Sith de l'AE
misc/md_syntax
misc/helpers
misc/prod
Documentations complémentaires
------------------------------

21
doc/misc/prod.rst Normal file
View File

@ -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.