Merge branch 'main' into 398-add-info-about-branch-names-and-commits

Author: sdelquin

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
 jobs:
   deploy:
     name: Deploy project

CONTRIBUTING.md

@@ -1,38 +1,64 @@
-## Cómo contribuir a este proyecto
+## Contribuyendo a este proyecto
 
 Si quieres contribuir a este proyecto, hay muchas cosas que puedes hacer.
 Tenemos una etiqueta en los _issues_ del [repositorio de este
-proyecto](https://github.com/pythoncanarias/pycan-web/issues) para 
+proyecto](https://github.com/pythoncanarias/pycan-web/issues) para
 [aquellas tareas que pensamos que son un buen punto de partida](https://github.com/pythoncanarias/pycan-web/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
 para empezar a contribuir
 al desarrollo.
 
+Si es la primera vez que vas a contribuir a un proyecto de _software_ libre,
+quizá te sea de ayuda este documento: [cómo hacer tu primera contribución a
+Python Canarias](docs/first-contrib.md).
+
 Además de las tareas propias de desarrollo, hay muchas otras formas de ayudar,
 una de las principales es aportar nuevas ideas para mejorar la web, así
-como avisarnos de cualquier error que encuentres en la misma.
-
-Para contribuir como desarrollador, en el documento [README.md](README.md) se
-explica cómo montar un entorno de desarrollo propio usando _Docker_ y
-_Docker Compose_.
-
-## Notas para los desarrolladores
-
-El desarrollo consiste en una aplicación Django, y algunas partes de _frontend_
+como avisarnos de cualquier error que encuentres en la misma. Esto lo puedes hacer creando un nuevo _issue_ [en la sección correspondiente de GitHub](https://github.com/pythoncanarias/pycan-web/issues).
+
+Para contribuir como desarrollador/a, hemos preparado un manual donde se explica [cómo montar un entorno de desarrollo](docs/dev.md) propio usando _Docker_ y _Docker Compose_.
+
+## Sobre el idioma a usar en este proyecto
+
+Estamos trabajando para definir los idiomas a usar en las distintas partes del
+proyecto, ya que ahora mismo hay una mezcla un poco aberrante entre inglés y
+español. Nuestro objetivo es ir migrando toda la documentación del proyecto a
+español, y reservar el inglés solo para las cuestiones que atañan al código
+directamente.
+
+Por tanto, si quieres aportar en las secciones de documentación, aunque
+encuentres el texto en inglés, puedes incluir lo nuevo es español, ya que la
+idea es ir traduciendo todos esos documentos hasta conseguir el estado mostrado
+en la siguiente tabla:
+
+| Área                  | Idioma |
+| --------------------- | ------ |
+| Variables en código   | 🇬🇧     |
+| Comentarios en código | 🇬🇧     |
+| _Commits_             | 🇬🇧     |
+| README                | 🇪🇸     |
+| Documentación         | 🇪🇸     |
+| _Issues_              | 🇪🇸     |
+| Etiquetas de _issues_ | 🇪🇸     |
+| _Pull Requests_       | 🇪🇸     |
+| Texto de la web       | 🇪🇸     |
+
+## Notas para desarrolladores
+
+El desarrollo consiste en un proyecto Django, y algunas partes de _frontend_
 escritas en _javascript_ plano. Por el momento no nos hemos decidido a usar
 ningún _framework_, aunque algunos del equipo tenemos una cierta preferencia
 por [vue.js](https://vuejs.org/).
 
-Se ha intentado seguir en lo posible las prácticas habituales en Django, pero
+Se ha intentado seguir en lo posible las [buenas prácticas habituales de Django](https://django-best-practices.readthedocs.io/en/latest/), pero
 en algunos casos se han realizado modificaciones sobre lo que podría
 considerarse un proyecto Django _estándar_. Explicaremos estas divergencias en las
 siguientes secciones.
 
 ### Organización de código de las aplicaciones de Django
 
 Como hay muchas aplicaciones o _apps_, las tenemos todas todas bajo una única
-carpeta `apps`, para reducir la cantidad de _ruido_  en
-la carpeta raíz. Si crees necesario añadir una nueva _app_, créala por favor al
-mismo nivel que las actuales.
+carpeta `apps`, para reducir la cantidad de _ruido_ en
+la carpeta raíz. Si crees necesario añadir una nueva _app_, [lee este documento con atención](docs/new-app.md).
 
 ### Estilo de código
 
@@ -44,7 +70,9 @@ debajo de 96 caracteres por línea.
 Algunos de nosotros usamos la herramienta [black](https://github.com/psf/black)
 para formatear el código, pero no se considera obligatorio.
 
-### Dependecias
+Así mismo, existen herramientas como [flake8](https://flake8.pycqa.org/en/latest/) que detectan divergencias del estilo de código frente a los estándares establecidos.
+
+### Dependencias
 
 Intentamos mantener el número de dependencias bajo. Un alto número de
 dependencias frena las actualizaciones generales, que es un objetivo que
@@ -65,8 +93,8 @@ Veamos, por ejemplo, la _app_ `notice`, que se usa para enviar notificaciones
 a los miembros ante determinados eventos, como por ejemplo el aviso un mes
 antes de que se venza su permanencia a la organización.
 
-En la clase `apps.notice.models.Notice` se definen algunos métodos, pero 
-solo aquellos que afectan o cambian el estado del propio modelo, sin 
+En la clase `apps.notice.models.Notice` se definen algunos métodos, pero
+solo aquellos que afectan o cambian el estado del propio modelo, sin
 ninguna tercera parte implicada. En concreto, no existe un método
 para enviar la notificación en si.
 
@@ -86,7 +114,7 @@ en un módulo aparte.
 Hay muchas razones para esto, pero veamos solo una. Si nos encontramos con una
 nueva clase mientras examinamos el código, lo deseable es que una búsqueda o un
 _grep_ por el nombre de la clase nos devuelva solo la definición y los usos de
-la misma. Cualquier otra cosa que aparezca será ruido.  Si tengo dos clases con
+la misma. Cualquier otra cosa que aparezca será ruido. Si tengo dos clases con
 el mismo nombre en ficheros diferentes, esto solo complica el entender en que
 contextos y de que forma se usa cada una de las clases. Razones similares se
 pueden argumentar para las variables o constantes globales.
@@ -142,4 +170,4 @@ Scopes aceptados:
 
 ```bash
 git commit -m 'feat: add blog template'
-```
+```

README.md

@@ -1,24 +1,23 @@
-<div align="center"> 
- 
-# Python Canarias
+<div align="center">
 
+# Python Canarias
 
-![Python Canarias Banner](docs/assets/python_canarias_banner.png)  
+![Python Canarias Banner](docs/assets/python_canarias_banner.png)
 
-Website of [Python Canarias](https://pythoncanarias.es/) 🚀 &nbsp; happily made with [Django](https://www.djangoproject.com/). 
+• Sitio Web de [Python Canarias](https://pythoncanarias.es/) 🚀 &nbsp; felizmente hecho con [Django](https://www.djangoproject.com/) •
 
 </div>
 
 ---
 
-## Table of contents
+## Tabla de contenido
 
-- [Contributing to this project](CONTRIBUTING.md).
-- [Development setup](docs/dev.md)
-- [Production setup](docs/prod.md)
-- [Adding new app](docs/new-app.md)
-- [API](docs/api.md)
+- [Contribuyendo a este proyecto](CONTRIBUTING.md).
+- [Configuración del entorno de desarrollo](docs/dev.md).
+- [Configuración del entorno de producción](docs/prod.md).
+- [Añadir una nueva app](docs/new-app.md).
+- [API](docs/api.md).
 
-## License
+## Licencia
 
-This project is licensed under [MIT](LICENSE.md).
+Este proyecto esta disponible bajo la licencia [MIT](LICENSE.md).

apps/about/admin.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+
+from . import models
+
+
+@admin.register(models.Ally)
+class AllyAdmin(admin.ModelAdmin):
+    list_display = (
+        'name',
+        'url',
+        'twitter',
+        'email',
+    )

apps/about/migrations/0001_initial.py

@@ -0,0 +1,26 @@
+# Generated by Django 2.2.24 on 2021-10-12 17:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Ally',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=120, verbose_name='Nombre')),
+                ('description', models.CharField(max_length=220, verbose_name='Descripción')),
+                ('logo', models.ImageField(blank=True, upload_to='about/allies/')),
+                ('url', models.URLField(blank=True)),
+                ('twitter', models.URLField(blank=True)),
+                ('email', models.EmailField(blank=True, max_length=254)),
+            ],
+        ),
+    ]

apps/about/models.py

@@ -0,0 +1,18 @@
+from django.db import models
+
+
+class Ally(models.Model):
+    '''Organizaciones/Asociaciones aliadas'''
+
+    name = models.CharField('Nombre', max_length=120)
+    description = models.CharField('Descripción', max_length=220)
+    logo = models.ImageField(upload_to='about/allies/', blank=True)
+    url = models.URLField(blank=True)
+    twitter = models.URLField(blank=True)
+    email = models.EmailField(blank=True)
+
+    def __str__(self):
+        return self.name
+
+    class Meta:
+        ordering = ['name']

apps/about/static/about/css/about-us.scss

@@ -0,0 +1,10 @@
+.about-index {
+  p {
+    padding-top: 0.5rem;
+    padding-bottom: 0.5rem;
+  }
+
+  .dyn-anchor-link i:hover {
+    color: tomato;
+  }
+}

apps/about/static/about/css/allies.scss

@@ -0,0 +1,22 @@
+.ally-block {
+  margin-bottom: 3rem;
+  img.logo {
+    width: 5rem;
+    vertical-align: middle;
+    margin-right: 1rem;
+  }
+  p.description {
+    i.quote {
+      color: gray;
+    }
+  }
+  ul {
+    list-style-type: none;
+    margin-left: 1rem;
+    padding-left: 1rem;
+    border-left: 2px solid lightgray;
+    i {
+      width: 1.5rem;
+    }
+  }
+}

apps/about/static/about/css/main.scss

@@ -1,13 +1,4 @@
 @import 'apps/commons/static/commons/css/base';
 
-.about-index {
-  p {
-    padding-top: .5rem;
-    padding-bottom: .5rem;
-  }
-
-  .message a.headerlink {
-    color: cadetblue;
-    text-decoration: none;
-  }
-}
+@import './about-us';
+@import './allies';

apps/about/templates/about/allies.html

@@ -0,0 +1,40 @@
+{% extends "about/base.html" %}
+{% load utils %}
+{% load static %}
+
+{% block title %}Aliados - {{ block.super }}{% endblock %}
+
+{% block content %}
+
+<div class="content box">
+
+<h1>Aliados</h1>
+
+<p>
+Canarias es un territorio muy prolífico en el campo de las nuevas tecnologías. Las organizaciones y asociaciones de este sector constituyen un punto de entrada para muchos usuarios y usuarias. Aquello de que la unión hace la fuerza es un principio que seguimos desde Python Canarias. Si bien apostamos, como era de esperar, por nuestro lenguaje de programación favorito, somos una comunidad abierta y nos encanta construir sinergias con otros grupos. Aquí les dejamos un listado de nuestros <b>aliados</b>:
+</p>
+
+{% for ally in allies %}
+  <div class="ally-block" id="{{ ally.name|slugify }}">
+    <h2 class="dyn-anchor-heading">
+      <img class="logo" src="{{ ally.logo.url }}"> {{ ally.name }}
+      <a class="dyn-anchor-link" href="#{{ ally.name|slugify }}"><i class="fas fa-link"></i></a>
+    </h2>
+    <p class="description"><i class="fas fa-quote-left quote"></i> {{ ally.description }} <i class="fas fa-quote-right quote"></i></p>
+    <ul>
+      {% if ally.url %}
+        <li><i class="fas fa-home"></i> <a href="{{ ally.url }}">{{ ally.url }}</a></li>
+      {% endif %}
+      {% if ally.twitter %}
+        <li><i class="fab fa-twitter"></i> <a href="{{ ally.twitter }}">{{ ally.twitter }}</a></li>
+      {% endif %}
+      {% if ally.email %}
+        <li><i class="far fa-envelope"></i> <a href="mailto:{{ ally.email }}">{{ ally.email }}</a></li>
+      {% endif %}
+    </ul>
+  </div>
+{% endfor %}
+
+</div>
+
+{% endblock content %}