Merge pull request #429 from mhered/216-Add-FAQ-section

sdelquin · web-flow · commit 046168f0fc67 · 2021-10-26T22:49:38.000+01:00
#216 add FAQ section
diff --git a/apps/about/admin.py b/apps/about/admin.py
@@ -11,3 +11,6 @@ class AllyAdmin(admin.ModelAdmin):
         'twitter',
         'email',
     )
+
+
+admin.site.register(models.FAQItem)
diff --git a/apps/about/migrations/0002_auto_20211019_2054.py b/apps/about/migrations/0002_auto_20211019_2054.py
@@ -0,0 +1,17 @@
+# Generated by Django 2.2.24 on 2021-10-19 20:54
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('about', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='ally',
+            options={'ordering': ['name']},
+        ),
+    ]
diff --git a/apps/about/migrations/0003_faqitem.py b/apps/about/migrations/0003_faqitem.py
@@ -0,0 +1,21 @@
+# Generated by Django 2.2.24 on 2021-10-26 17:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('about', '0002_auto_20211019_2054'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='FAQItem',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('question', models.CharField(max_length=200)),
+                ('answer', models.TextField()),
+            ],
+        ),
+    ]
diff --git a/apps/about/models.py b/apps/about/models.py
@@ -16,3 +16,13 @@ def __str__(self):
 
     class Meta:
         ordering = ['name']
+
+
+class FAQItem(models.Model):
+    '''Preguntas frecuentes'''
+
+    question = models.CharField(max_length=200)
+    answer = models.TextField()
+
+    def __str__(self):
+        return self.question
diff --git a/apps/about/static/about/css/about-us.scss b/apps/about/static/about/css/about-us.scss
diff --git a/apps/about/static/about/css/main.scss b/apps/about/static/about/css/main.scss
@@ -1,4 +1,3 @@
 @import 'apps/commons/static/commons/css/base';
 
-@import './about-us';
 @import './allies';
diff --git a/apps/about/templates/about/faq_list.html b/apps/about/templates/about/faq_list.html
@@ -0,0 +1,26 @@
+{% extends "about/base.html" %}
+
+{% load utils %}
+
+{% block title %}Asociación - {{ block.super }}{% endblock %}
+
+{% block body_class %}faq-index{% endblock %}
+
+{% block content %}
+
+<div class="content box">
+    <h1 class="title">FAQ</h1>
+    {% for faq in faqs %}
+        <article class="anchor" id="{{ faq.question|slugify }}">
+            <div class="message-header dyn-anchor-heading">
+                {{ faq.question }}
+                <a class="dyn-anchor-link" href="#{{ faq.question|slugify }}"><i class="fas fa-link"></i></a>
+            </div>
+            <div class="message-body">
+                {{ faq.answer|as_markdown }}
+            </div>
+        </article>
+    {% endfor %}
+</div>
+
+{% endblock content %}
diff --git a/apps/about/templates/about/index.html b/apps/about/templates/about/index.html
@@ -14,8 +14,7 @@
   <a href="{% url 'about:join' %}" class="link button is-link is-medium is-outlined">Forma parte de la asociación</a>
 </div>
 
-<article class="message" id="intro">
-  <a id="intro"></a>
+<article class="anchor" id="intro">
   <div class="message-header dyn-anchor-heading">
     Introducción 
     <a class="dyn-anchor-link" href="#intro"><i class="fas fa-link"></i></a>
@@ -31,8 +30,7 @@
   </div>
 </article>
 
-<article class="message" id="whypython">
-  <a id="whypython"></a>
+<article class="anchor" id="whypython">
   <div class="message-header dyn-anchor-heading">
     ¿Por qué Python?
     <a class="dyn-anchor-link" href="#whypython"><i class="fas fa-link"></i></a>
@@ -42,8 +40,7 @@
   </div>
 </article>
 
-<article class="message" id="fiscal">
-  <a id="fiscal"></a>
+<article class="anchor" id="fiscal">
   <div class="message-header dyn-anchor-heading">
     Datos fiscales
     <a class="dyn-anchor-link" href="#fiscal"><i class="fas fa-link"></i></a>
@@ -63,8 +60,7 @@
   </div>
 </article>
 
-<article class="message" id="board">
-  <a id="board"></a>
+<article class="anchor" id="board">
   <div class="message-header dyn-anchor-heading">
     Junta directiva
     <a class="dyn-anchor-link" href="#board"><i class="fas fa-link"></i></a>
@@ -82,8 +78,7 @@
   </div>
 </article>
 
-<article class="message" id="docs">
-  <a id="docs"></a>
+<article class="anchor" id="docs">
   <div class="message-header dyn-anchor-heading">
     Documentación
     <a class="dyn-anchor-link" href="#docs"><i class="fas fa-link"></i></a>
diff --git a/apps/about/urls.py b/apps/about/urls.py
@@ -10,4 +10,5 @@
     path('join/', views.join, name='join'),
     path('history/', views.history, name='history'),
     path('allies/', views.allies, name='allies'),
+    path('faq/', views.faq_list, name='faq'),
 ]
diff --git a/apps/about/views.py b/apps/about/views.py
@@ -4,7 +4,7 @@
 
 from apps.members.models import Position
 
-from .models import Ally
+from .models import Ally, FAQItem
 
 logger = logging.getLogger(__name__)
 
@@ -35,3 +35,8 @@ def history(request):
 def allies(request):
     allies = Ally.objects.all()
     return render(request, 'about/allies.html', {'allies': allies})
+
+
+def faq_list(request):
+    faqs = FAQItem.objects.order_by('id')
+    return render(request, 'about/faq_list.html', {'faqs': faqs})
diff --git a/apps/commons/static/commons/css/base.scss b/apps/commons/static/commons/css/base.scss
@@ -40,7 +40,7 @@ body {
     }
   }
 
-  @include from($desktop){
+  @include from($desktop) {
     padding: 2rem 0rem 5rem 0rem;
   }
 
@@ -53,7 +53,6 @@ body {
   }
 }
 
- 
 .footer-page {
   background-color: $footer-bg;
   position: relative;
@@ -71,14 +70,12 @@ body {
   .footer-column {
     color: #ebebeb;
     padding-top: 2rem;
-  
   }
 
   h1,
   h2 {
     color: whitesmoke;
   }
-
 }
 
 /* Error class for Django Forms https://bit.ly/3vidyK2 */
@@ -96,7 +93,6 @@ body {
   width: 100%;
   z-index: 1;
 
-
   & .notification {
     width: $notification-width;
     margin-left: auto;
@@ -106,7 +102,7 @@ body {
   }
 }
 .message {
-  scroll-margin-top:  $header-height + 1rem;
+  scroll-margin-top: $header-height + 1rem;
 }
 
 .container {
diff --git a/apps/commons/static/commons/css/dyn-anchors.scss b/apps/commons/static/commons/css/dyn-anchors.scss
@@ -13,6 +13,13 @@
     }
   }
 }
+
 .anchor {
-  scroll-margin-top:  $header-height + 1rem;
+  scroll-margin-top: $header-height + 1rem;
+}
+
+.message-header {
+  .dyn-anchor-link i:hover {
+    color: tomato;
+  }
 }
diff --git a/apps/commons/static/commons/css/override.scss b/apps/commons/static/commons/css/override.scss
@@ -20,7 +20,6 @@ hr {
   }
 }
 
-
 .message.is-info .message-body {
   border-color: #c8dfec;
 }
@@ -29,31 +28,30 @@ hr {
   background-color: #f3f3f7;
 }
 
-.collapsable--close{
+.collapsable--close {
   display: none;
 }
 
-.nav-menu{
- display:flex;
+.nav-menu {
+  display: flex;
   justify-content: center;
-  align-items: center; 
-} 
+  align-items: center;
+}
 
-.navbar-dropdown{
+.navbar-dropdown {
   background-color: $header-bg;
 }
 
-.navbar-burger{
+.navbar-burger {
   color: $header-fg;
 }
 
 .navbar {
-  
   .navbar-brand {
     background: $header-bg;
     .navbar-item {
       padding: 0.35rem 1rem;
-      
+
       .logo {
         margin-top: 2px; // offset logo
         max-height: $header-height;
@@ -113,3 +111,15 @@ hr {
   }
 }
 
+.message-body {
+  p {
+    text-align: justify;
+  }
+  p:not(:last-child) {
+    padding-bottom: 0.5rem;
+  }
+}
+
+article {
+  margin-bottom: 1rem;
+}
diff --git a/apps/commons/templates/header.html b/apps/commons/templates/header.html
@@ -25,6 +25,7 @@
               <a class="navbar-item {% is_active 'about:history' %}" href="{% url 'about:history' %}">Historia</a>
               <a class="navbar-item {% is_active 'about:join' %}" href="{% url 'about:join' %}">¡Únete!</a>
               <a class="navbar-item {% is_active 'about:allies' %}" href="{% url 'about:allies' %}">Aliados</a>
+              <a class="navbar-item {% is_active 'about:faq' %}" href="{% url 'about:faq' %}">FAQ</a>
           </div>
       </div>
       <div class="navbar-item has-dropdown is-hoverable">
@@ -37,7 +38,7 @@
             <a class="navbar-item {% is_active 'events:past_events' %}" href="{% url 'events:past_events' %}">Eventos pasados</a>
             </div>
       </div>
-     
+
       <a class="navbar-item {% is_active 'jobs:index' %}" href="{% url 'jobs:index' %}">
           <i class="fas fa-laptop-code"></i>
           Empleo
diff --git a/apps/dev/management/commands/dbload.py b/apps/dev/management/commands/dbload.py
@@ -4,8 +4,8 @@
 from django.conf import settings
 from django.core.files.uploadedfile import UploadedFile
 from django.core.management.base import BaseCommand
-from apps.about.models import Ally
 
+from apps.about.models import Ally, FAQItem
 from apps.locations.models import Venue
 from apps.organizations.models import Organization
 from apps.quotes.models import Author
@@ -64,7 +64,9 @@ def add_allies():
         photo = UploadedFile(fin, name=photo_path.name)
         Ally(
             name='AdaLoveDev',
-            description='Somos una comunidad sin ánimo de lucro cuyo objetivo es dar visibilidad y empoderamiento a las mujeres en el sector tecnológico',
+            description='Somos una comunidad sin ánimo de lucro cuyo objetivo'
+            'es dar visibilidad y empoderamiento a las mujeres en el sector'
+            'tecnológico',
             logo=photo,
             url='https://adalovedev.es/',
             twitter='https://twitter.com/adalovedev',
@@ -76,7 +78,9 @@ def add_allies():
         photo = UploadedFile(fin, name=photo_path.name)
         Ally(
             name='Python España',
-            description='Asociación Python España. Trabajando para promover y visibilizar el uso del lenguaje de programación Python en nuestro país',
+            description='Asociación Python España. Trabajando para promover y'
+            'visibilizar el uso del lenguaje de programación Python en nuestro'
+            'país',
             logo=photo,
             url='https://www.es.python.org/',
             twitter='https://twitter.com/python_es',
@@ -114,11 +118,32 @@ def add_events():
         start_date=datetime.date(2023, 9, 23),
         default_slot_duration=datetime.timedelta(minutes=50),
         short_description='Charlas informales de Python',
-        description='Bocadillos, vino, y Python, todo opcional menos lo último.',
+        description='Bocadillos, vino y Python, todo opcional menos lo último',
         closed_schedule=False,
     )
 
 
+def add_faq_items():
+    print('Adding sample faq item about Python')
+    FAQItem(
+        question='¿Qué es Python?',
+        answer='''Python es un lenguaje de programación interpretado cuya
+filosofía hace hincapié en la legibilidad de su código. Se trata de
+un lenguaje de programación multiparadigma, ya que soporta parcialmente la
+orientación a objetos, programación imperativa y, en menor medida,
+programación funcional. Es un lenguaje interpretado, dinámico y
+multiplataforma.''',
+    ).save()
+
+    print('Adding sample faq item about Python benefits')
+    FAQItem(
+        question='¿Es Python un buen lenguaje para empezar a programar?',
+        answer='''Sí. Python tiene una sintaxis simple y consistente, dispone
+de una librería estándar muy completa. Al ser multiparadigma sirve de
+introducción para programación orientada a objetos, funcional y procedural.''',
+    ).save()
+
+
 class Command(BaseCommand):
     """
     Add a few entries to the database to allow a minimum developer experience
@@ -131,3 +156,4 @@ def handle(self, *args, **options):
         add_quotes()
         add_events()
         add_allies()
+        add_faq_items()
diff --git a/apps/jobs/templates/jobs/list_jobs.html b/apps/jobs/templates/jobs/list_jobs.html

Original file line number	Diff line number	Diff line change
`@@ -11,3 +11,6 @@ class AllyAdmin(admin.ModelAdmin):`
`11`	`11`	`'twitter',`
`12`	`12`	`'email',`
`13`	`13`	`)`
	`14`	`+`
	`15`	`+`
	`16`	`+admin.site.register(models.FAQItem)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`@import 'apps/commons/static/commons/css/base';`
`2`	`2`
`3`		`-@import './about-us';`
`4`	`3`	`@import './allies';`
Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,5 @@`
`10`	`10`	`path('join/', views.join, name='join'),`
`11`	`11`	`path('history/', views.history, name='history'),`
`12`	`12`	`path('allies/', views.allies, name='allies'),`
	`13`	`+ path('faq/', views.faq_list, name='faq'),`
`13`	`14`	`]`