Merge pull request #449 from pythoncanarias/docs-improvements

Mejoras en documentación

Author: sdelquin

.gitignore

@@ -99,3 +99,4 @@ tags
 
 certificates/media
 .prettierignore
+.parcel-cache/

apps/organizations/models.py

@@ -63,12 +63,12 @@ class Meta:
 
 
 def clear_organization_cache(sender, **kwargs):
-    """Limpia la cache de la informacion sobre la organizacion.
+    """Limpia la cache de la información sobre la organización.
 
-    Ver commons.content_procesors.main_organization_data.
+    Ver `commons.content_procesors.main_organization_data`.
 
-    Cada vez que se almacene informacion en la tabla de organizaciones,
-    se elmimina la cache.
+    Cada vez que se almacene o modifique información en la tabla de organizaciones,
+    se borra la cache.
     """
     key = 'organizations.organization'
     cache.delete(key)

ctags-exclude-names.txt

@@ -0,0 +1,2 @@
+.static
+node_modules

docs/prod.md

@@ -53,6 +53,9 @@ Usamos **Redis** para algunos servicios. Sigue estas indicaciones para confirgur
 1. Instala [Redis](https://redis.io/download).
 2. Ejecuta `run-rq.sh`
 
+Para saber más sobre la configuración y uso de Redis, puedes leer
+[./uso-de-redis.md](redis.md)
+
 ## Notificaciones
 
 Tenemos una app de Django para enviar notificaciones por email. Para enviar estas notificaciones, es necesario ejecutar el script `run-notices.sh` periódicamente (por ejemplo diariamente) a través de cron.

docs/uso-de-redis.md

@@ -0,0 +1,49 @@
+## Sobre el servidor de cache
+
+Lo más sencillo sería usar `memcached`, pero en nuestro caso creo que tiene más
+sentido usar `redis` porque ya está instalada en producción y el rendimiento
+es similar. Eso si, hay que instalar `django-redis`, que ya está en el fichero
+`requiremenst.txt`:
+
+
+### Configurar la cache
+
+Hay que habilitar la configuración, en el fichero `settings.py`, para que
+reconozca _Redis_ como caché por defecto. Este sería un ejemplo de configuración:
+
+```python
+CACHES = {
+    "default": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": "redis://127.0.0.1:6379/1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient"
+        },
+        "KEY_PREFIX": "web"
+    }
+}
+```
+
+El campo `KEY_PREFIX`, si se define, se añade automáticamente a todos las
+claves que se almacenan en _Redis_. He puesto `web` para hacer una "espacio de
+nombres" para todo lo que sea web.
+
+Si queremos optimizar el uso de la caché, podemos añadir un `signal` a los
+modelos para que se borre la caché cada vez que se cambien los datos.  Esto lo
+usamos para cachear los datos de la organización (Para más detalles ver
+`apps\organizations\models.py`).
+
+### Desarrollo local
+
+Para no complicar el desarrollo, se puede indicar en la configuración que use
+la memoria local de la máquina a modo de cache. Así no hay que instalar
+_Redis_, si no queremos.
+
+```python
+CACHES = {
+    'default': {
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+    }
+}
+```
+

justfile

@@ -0,0 +1,44 @@
+# Ejecutar comprobaciones del proyecto Django + Flake8 + Vulture
+check:
+    python manage.py check
+    flake8 --count **/*.py
+    vulture .
+
+
+# Borrar ficheros temporales y espurios
+clean:
+    find . -type f -name "*.pyc" -delete
+    find . -type d -name "__pycache__" -exec rm -r "{}" \;
+    find . -type d -name ".sass-cache" -exec rm -r "{}" \;
+
+
+# Ejecuta las migraciones pendientes"
+migrate:
+    python manage.py migrate
+
+
+# Ejecutar el servidor en modo producción
+run: check static
+    python manage.py runserver
+
+
+# Ejecutar el servidor en modo desarrollo
+rundev: static
+    DEBUG=yes python manage.py runserver_plus
+
+
+# Abre una shell python con el entorno de Django cargado
+shell:
+    python manage.py shell_plus
+
+
+# Actualiza contenidos estáticos
+static:
+    python manage.py collectstatic --no-input
+    #sass --sourcemap=none bulma/custom.scss:commons/static/commons/vendor.min.css
+    #sass --sourcemap=none about/static/about/css/main.scss:about/static/about/custom.min.css
+
+
+# [Re]crear el fichero ctags
+tags:
+    ctags -R --exclude=@ctags-exclude-names.txt .