Merge pull request #1656 from consul/chore/add_markdownlinter

Add Markdown Linter gem and config file && Fixes
This commit is contained in:
Raimond Garcia
2017-06-19 10:46:31 +02:00
committed by GitHub
12 changed files with 72 additions and 61 deletions

1
.mdlrc Normal file
View File

@@ -0,0 +1 @@
rules "MD001", "MD002", "MD003", "MD004", "MD005", "MD006", "MD007", "MD008", "MD009", "MD010", "MD011", "MD012", "MD014", "MD015", "MD016", "MD017", "MD018", "MD019", "MD020", "MD021", "MD022", "MD023", "MD024", "MD025", "MD026", "MD027", "MD028", "MD029", "MD030", "MD031", "MD032", "MD033", "MD034", "MD035", "MD036", "MD037", "MD038", "MD039", "MD040", "MD041"

View File

@@ -1,3 +1,5 @@
# How to Contribute to this Project
## Team members ## Team members
* Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000) * Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000)

View File

@@ -1,3 +1,5 @@
# Cómo Contribuir a este Projecto
## Miembros del equipo ## Miembros del equipo
* Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000) * Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000)

View File

@@ -68,6 +68,7 @@ In order to make changes to any CSS selector (custom style sheets), you can add
background: red; background: red;
} }
``` ```
If you want to change any [foundation](http://foundation.zurb.com/) variable, you can do it at the `app/assets/stylesheets/_custom_settings.scss` file. For example to change the main application color just add: If you want to change any [foundation](http://foundation.zurb.com/) variable, you can do it at the `app/assets/stylesheets/_custom_settings.scss` file. For example to change the main application color just add:
```css ```css
@@ -125,7 +126,6 @@ end
Do not forget to cover your changes with a test at the `spec/models/custom` folder. Following the example we could create `spec/models/custom/residence_spec.rb`: Do not forget to cover your changes with a test at the `spec/models/custom` folder. Following the example we could create `spec/models/custom/residence_spec.rb`:
```ruby ```ruby
require 'rails_helper' require 'rails_helper'
@@ -181,7 +181,6 @@ And then just do the classic Ruby on Rails flow `bundle install` and following a
If you need to extend or modify the `config/application.rb` just do it at the `config/application_custom.rb` file. For example if you want to change de default language to English, just add: If you need to extend or modify the `config/application.rb` just do it at the `config/application_custom.rb` file. For example if you want to change de default language to English, just add:
```ruby ```ruby
module Consul module Consul
class Application < Rails::Application class Application < Rails::Application
@@ -210,7 +209,7 @@ TODO
We recommend you to add consul as remote: We recommend you to add consul as remote:
``` ```
$ git remote add consul https://github.com/consul/consul git remote add consul https://github.com/consul/consul
``` ```
And then just grab lastest changes on to a branch of your own repo with: And then just grab lastest changes on to a branch of your own repo with:

View File

@@ -68,6 +68,7 @@ Si quieres cambiar algun selector CSS (de las hojas de estilo) puedes hacerlo en
background: red; background: red;
} }
``` ```
Si quieres cambiar alguna variable de [foundation](http://foundation.zurb.com/) puedes hacerlo en el fichero `app/assets/stylesheets/_custom_settings.scss`. Por ejemplo para cambiar el color general de la aplicación puedes hacerlo agregando: Si quieres cambiar alguna variable de [foundation](http://foundation.zurb.com/) puedes hacerlo en el fichero `app/assets/stylesheets/_custom_settings.scss`. Por ejemplo para cambiar el color general de la aplicación puedes hacerlo agregando:
```css ```css
@@ -125,7 +126,6 @@ end
No olvides poner los tests relevantes en `spec/models/custom`, siguiendo con el ejemplo pondriamos lo siguiente en `spec/models/custom/residence_spec.rb`: No olvides poner los tests relevantes en `spec/models/custom`, siguiendo con el ejemplo pondriamos lo siguiente en `spec/models/custom/residence_spec.rb`:
```ruby ```ruby
require 'rails_helper' require 'rails_helper'
@@ -181,7 +181,6 @@ Y siguiendo el flujo clásico en Ruby on Rails (`bundle install` y seguir con lo
Cuando necesites extender o modificar el `config/application.rb` puedes hacerlo a través del fichero `config/application_custom.rb`. Por ejemplo si quieres modificar el idioma por defecto al inglés pondrías lo siguiente: Cuando necesites extender o modificar el `config/application.rb` puedes hacerlo a través del fichero `config/application_custom.rb`. Por ejemplo si quieres modificar el idioma por defecto al inglés pondrías lo siguiente:
```ruby ```ruby
module Consul module Consul
class Application < Rails::Application class Application < Rails::Application
@@ -210,7 +209,7 @@ TODO
Te recomendamos que agregues el remote de consul para facilitar este proceso de merge: Te recomendamos que agregues el remote de consul para facilitar este proceso de merge:
``` ```
$ git remote add consul https://github.com/consul/consul git remote add consul https://github.com/consul/consul
``` ```
Con esto puedes actualizarte con Con esto puedes actualizarte con

View File

@@ -107,6 +107,7 @@ group :test do
end end
group :development do group :development do
gem 'mdl', require: false
# Access an IRB console on exception pages or by using <%= console %> in views # Access an IRB console on exception pages or by using <%= console %> in views
gem 'scss_lint', require: false gem 'scss_lint', require: false
gem 'web-console', '3.3.0' gem 'web-console', '3.3.0'

View File

@@ -226,6 +226,7 @@ GEM
knapsack (1.13.3) knapsack (1.13.3)
rake rake
timecop (>= 0.1.0) timecop (>= 0.1.0)
kramdown (1.13.2)
launchy (2.4.3) launchy (2.4.3)
addressable (~> 2.3) addressable (~> 2.3)
letter_opener (1.4.1) letter_opener (1.4.1)
@@ -238,12 +239,18 @@ GEM
nokogiri (>= 1.5.9) nokogiri (>= 1.5.9)
mail (2.6.6) mail (2.6.6)
mime-types (>= 1.16, < 4) mime-types (>= 1.16, < 4)
mdl (0.4.0)
kramdown (~> 1.12, >= 1.12.0)
mixlib-cli (~> 1.7, >= 1.7.0)
mixlib-config (~> 2.2, >= 2.2.1)
mime-types (3.1) mime-types (3.1)
mime-types-data (~> 3.2015) mime-types-data (~> 3.2015)
mime-types-data (3.2016.0521) mime-types-data (3.2016.0521)
mimemagic (0.3.2) mimemagic (0.3.2)
mini_portile2 (2.1.0) mini_portile2 (2.1.0)
minitest (5.10.1) minitest (5.10.1)
mixlib-cli (1.7.0)
mixlib-config (2.2.4)
multi_json (1.12.1) multi_json (1.12.1)
multi_xml (0.6.0) multi_xml (0.6.0)
multipart-post (2.0.0) multipart-post (2.0.0)
@@ -521,6 +528,7 @@ DEPENDENCIES
knapsack knapsack
launchy launchy
letter_opener_web (~> 1.3.1) letter_opener_web (~> 1.3.1)
mdl
newrelic_rpm (~> 4.1.0.333) newrelic_rpm (~> 4.1.0.333)
omniauth omniauth
omniauth-facebook (~> 4.0.0) omniauth-facebook (~> 4.0.0)

View File

@@ -46,6 +46,7 @@ RAILS_ENV=test rake db:setup
``` ```
Run the app locally: Run the app locally:
``` ```
bin/rails s bin/rails s
``` ```
@@ -81,7 +82,9 @@ But for some actions like voting, you will need a verified user, the seeds file
**pass:** 12345678 **pass:** 12345678
### Customization ### Customization
Read more on documentation: Read more on documentation:
* English: [CUSTOMIZE_EN.md](CUSTOMIZE_EN.md) * English: [CUSTOMIZE_EN.md](CUSTOMIZE_EN.md)
* Spanish: [CUSTOMIZE_ES.md](CUSTOMIZE_ES.md) * Spanish: [CUSTOMIZE_ES.md](CUSTOMIZE_ES.md)

View File

@@ -16,7 +16,6 @@ Aplicación de Participación Ciudadana y Gobierno Abierto
[![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Este es el repositorio de código abierto de la Aplicación de Participación Ciudadana Consul, creada originariamente por el Ayuntamiento de Madrid. Este es el repositorio de código abierto de la Aplicación de Participación Ciudadana Consul, creada originariamente por el Ayuntamiento de Madrid.
## Estado del proyecto ## Estado del proyecto
@@ -47,6 +46,7 @@ RAILS_ENV=test rake db:setup
``` ```
Para ejecutar la aplicación en local: Para ejecutar la aplicación en local:
``` ```
bin/rails s bin/rails s
``` ```

View File

@@ -6,7 +6,7 @@
* [Perfiles de administrador, moderador y gestor](#perfiles-de-administrador,-moderador-y-gestor) * [Perfiles de administrador, moderador y gestor](#perfiles-de-administrador,-moderador-y-gestor)
* [Perfiles de evaluador y presidente de mesa](#perfiles-de-evaluador-y-presidente-de-mesa) * [Perfiles de evaluador y presidente de mesa](#perfiles-de-evaluador-y-presidente-de-mesa)
# Funcionalidades ## Funcionalidades
Actualmente Consul soporta: Actualmente Consul soporta:
@@ -17,7 +17,7 @@ Actualmente Consul soporta:
* Comentarios anidados en debates y propuestas. * Comentarios anidados en debates y propuestas.
* Presupuestos participativos a través de distintas fases. * Presupuestos participativos a través de distintas fases.
# Registro de usuario ## Registro de usuario
Para registrar un usuario nuevo es posible hacerlo en la propia aplicación, dando un nombre de usuario (nombre público que aparecerá en tus publicaciones), un correo electrónico y una contraseña con la que se accederá a la web. Se deben aceptar las condiciones de uso. El usuario debe confirmar su correo electrónico para poder iniciar sesión. Para registrar un usuario nuevo es posible hacerlo en la propia aplicación, dando un nombre de usuario (nombre público que aparecerá en tus publicaciones), un correo electrónico y una contraseña con la que se accederá a la web. Se deben aceptar las condiciones de uso. El usuario debe confirmar su correo electrónico para poder iniciar sesión.
@@ -42,7 +42,7 @@ Para esta funcionalidad hace falta que el padrón municipal soporte la posibilid
![Verificación de usuario](imgs/user_verification.png?raw=true "Verificación de usuario") ![Verificación de usuario](imgs/user_verification.png?raw=true "Verificación de usuario")
# Perfil de usuario ## Perfil de usuario
Dentro de su perfil ("Mi cuenta" en el menú superior) cada usuario puede configurar si quiere mostrar públicamente su lista de actividades, así como las notificaciones que le enviará la aplicación a través de correo electrónico. Estas notificiaciones pueden ser: Dentro de su perfil ("Mi cuenta" en el menú superior) cada usuario puede configurar si quiere mostrar públicamente su lista de actividades, así como las notificaciones que le enviará la aplicación a través de correo electrónico. Estas notificiaciones pueden ser:
@@ -52,21 +52,21 @@ Dentro de su perfil ("Mi cuenta" en el menú superior) cada usuario puede config
* Recibir resumen de notificaciones sobre propuestas. * Recibir resumen de notificaciones sobre propuestas.
* Recibir emails con mensajes privados. * Recibir emails con mensajes privados.
# Perfiles de administrador, moderador y gestor ## Perfiles de administrador, moderador y gestor
Consul cuenta con tres perfiles de usuario para administrar contenidos de la web: administrador, moderador y gestor. Además tiene otros dos perfiles para gestión de procesos participativos: [evaluador y presidente de mesa](#perfiles_de_evaluador,_gestor_y_presidente_de_mesa), que se detallan más abajo. Consul cuenta con tres perfiles de usuario para administrar contenidos de la web: administrador, moderador y gestor. Además tiene otros dos perfiles para gestión de procesos participativos: [evaluador y presidente de mesa](#perfiles_de_evaluador,_gestor_y_presidente_de_mesa), que se detallan más abajo.
Los usuarios con perfil de administrador pueden asignar cualquier tipo de perfil a cualquier tipo de usuario. Sin embargo, todos los perfiles tienen que ser usuarios verificados (contrastados con el padrón municipal) para poder realizar ciertas acciones (por ejemplo, los gestores necesitan estar verificados para crear propuestas de inversión). Los usuarios con perfil de administrador pueden asignar cualquier tipo de perfil a cualquier tipo de usuario. Sin embargo, todos los perfiles tienen que ser usuarios verificados (contrastados con el padrón municipal) para poder realizar ciertas acciones (por ejemplo, los gestores necesitan estar verificados para crear propuestas de inversión).
## Panel Administrar ### Panel Administrar
![Panel de administración](imgs/panel_administration.png?raw=true "Panel de administración") ![Panel de administración](imgs/panel_administration.png?raw=true "Panel de administración")
Desde aquí puedes administrar el sistema, a través de los siguientes menús: Desde aquí puedes administrar el sistema, a través de los siguientes menús:
### Categorías ![categorias](imgs/icon_categories.png?raw=true "categorías") #### Categorías ![categorias](imgs/icon_categories.png?raw=true "categorías")
#### Temas de debates/propuestas ##### Temas de debates/propuestas
Los temas (también llamados tags, o etiquetas) son palabras que definen los usuarios al crear debates o propuestas para facilitar su catalogación (ej: sanidad, movilidad, arganzuela, ...). Desde aquí el administrador tiene las siguientes opciones: Los temas (también llamados tags, o etiquetas) son palabras que definen los usuarios al crear debates o propuestas para facilitar su catalogación (ej: sanidad, movilidad, arganzuela, ...). Desde aquí el administrador tiene las siguientes opciones:
@@ -74,10 +74,9 @@ Los temas (también llamados tags, o etiquetas) son palabras que definen los usu
* Eliminar temas inapropiados * Eliminar temas inapropiados
* Marcar temas para que aparezcan como sugerencia al crear debates/propuestas. Cada usuario puede crear los que quiera, pero el administrador puede sugerir algunos que le parezcan útiles como catalogación por defecto. Marcando "Proponer tema al crear la propuesta" en cada tema, establece cuáles se sugieren. * Marcar temas para que aparezcan como sugerencia al crear debates/propuestas. Cada usuario puede crear los que quiera, pero el administrador puede sugerir algunos que le parezcan útiles como catalogación por defecto. Marcando "Proponer tema al crear la propuesta" en cada tema, establece cuáles se sugieren.
#### Contenido moderado ![contenido moderado](imgs/icon_moderated_content.png?raw=true "contenido moderado")
### Contenido moderado ![contenido moderado](imgs/icon_moderated_content.png?raw=true "contenido moderado") ##### Propuestas/Debates/Comentarios ocultos
#### Propuestas/Debates/Comentarios ocultos
Cuando un administrador o moderador oculta una Propuesta/Debate/Comentario desde la web, aparecerá en esta lista. De esta forma los administradores pueden revisar los elementos que se han ocultado y subsanar posibles errores. Cuando un administrador o moderador oculta una Propuesta/Debate/Comentario desde la web, aparecerá en esta lista. De esta forma los administradores pueden revisar los elementos que se han ocultado y subsanar posibles errores.
@@ -88,14 +87,14 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones: "Pen
Es recomendable revisar regularmente la sección "Pendientes". Es recomendable revisar regularmente la sección "Pendientes".
#### Usuarios bloqueados
### Usuarios bloqueados
Cuando un moderador o un administrador bloquea a un usuario desde la web aparecerá en esta lista. Cuando un usuario está bloqueado no puede realizar acciones en la web, y todas sus Propuestas/Debates/Comentarios dejaran de ser visibles. Cuando un moderador o un administrador bloquea a un usuario desde la web aparecerá en esta lista. Cuando un usuario está bloqueado no puede realizar acciones en la web, y todas sus Propuestas/Debates/Comentarios dejaran de ser visibles.
* Al pulsar "Confirmar" se acepta el bloqueo; se considera que se ha hecho correctamente. * Al pulsar "Confirmar" se acepta el bloqueo; se considera que se ha hecho correctamente.
* Si se considera que el bloqueo ha sido erróneo, al pulsar "Volver a mostrar" se revierte el bloqueo y el usuario vuelve a estar activo. * Si se considera que el bloqueo ha sido erróneo, al pulsar "Volver a mostrar" se revierte el bloqueo y el usuario vuelve a estar activo.
### Votaciones ![votaciones](imgs/icon_polls.png?raw=true "votaciones") #### Votaciones ![votaciones](imgs/icon_polls.png?raw=true "votaciones")
Se puede crear una votación pulsando "Crear votación" y definiendo un nombre, fecha de apertura y de cierre. Adicionalmente se puede restringir la votación a unas zonas determinadas marcando "Restringir por zonas". Las zonas disponibles se definen en el menú [Gestionar distritos](#gestionar-distritos). Se puede crear una votación pulsando "Crear votación" y definiendo un nombre, fecha de apertura y de cierre. Adicionalmente se puede restringir la votación a unas zonas determinadas marcando "Restringir por zonas". Las zonas disponibles se definen en el menú [Gestionar distritos](#gestionar-distritos).
@@ -103,31 +102,27 @@ Los usuarios tienen que estar verificados para poder participar en la votación.
Una vez que se ha creado la votación, se definen y se agregan sus componentes. Las votaciones tienen tres componentes: Preguntas ciudadanas, Presidentes de mesa y Ubicación de las urnas. Una vez que se ha creado la votación, se definen y se agregan sus componentes. Las votaciones tienen tres componentes: Preguntas ciudadanas, Presidentes de mesa y Ubicación de las urnas.
##### Preguntas ciudadanas
#### Preguntas ciudadanas
Se puede crear una pregunta ciudadana o buscar una existente. Al crear la pregunta se puede asignar a una votación determinada. También se puede modificar la asignación a una pregunta existente pulsando el ella y seleccionando "Editar". Se puede crear una pregunta ciudadana o buscar una existente. Al crear la pregunta se puede asignar a una votación determinada. También se puede modificar la asignación a una pregunta existente pulsando el ella y seleccionando "Editar".
Desde el apartado de Preguntas ciudadanas también se pueden asignar a una votación aquellas Propuestas ciudadanas que han superado el umbral de apoyos. Se pueden seleccionar desde la pestaña "Propuestas que han superado el umbral". Desde el apartado de Preguntas ciudadanas también se pueden asignar a una votación aquellas Propuestas ciudadanas que han superado el umbral de apoyos. Se pueden seleccionar desde la pestaña "Propuestas que han superado el umbral".
##### Presidentes de mesa
#### Presidentes de mesa
Cualquier usuario registrado en la web puede convertirse en Presidente de mesa. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como Presidente de mesa". Cuando los presidentes acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Presidentes de mesa". Cualquier usuario registrado en la web puede convertirse en Presidente de mesa. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como Presidente de mesa". Cuando los presidentes acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Presidentes de mesa".
##### Ubicación de las urnas
#### Ubicación de las urnas
Para añadir una urna a la lista, seleccionar "Añadir urna" y a continuación completar los datos de nombre de la urna y ubicación. Para añadir una urna a la lista, seleccionar "Añadir urna" y a continuación completar los datos de nombre de la urna y ubicación.
#### Presupuestos participativos ![presupuestos participativos](imgs/icon_participatory_budgeting.png?raw=true "presupuestos participativos")
### Presupuestos participativos ![presupuestos participativos](imgs/icon_participatory_budgeting.png?raw=true "presupuestos participativos")
Desde esta sección se puede crear un presupuesto participativo seleccionando "Crear nuevo presupuesto" o editar uno existente. Al editar se puede cambiar la fase en la que se encuentra el proceso; este cambio se reflejará en la web. También se pueden crear grupos de partidas presupuestarias y agregar propuestas de inversión que hayan sido creadas previamente por un [gestor](#panel-gestión). Desde esta sección se puede crear un presupuesto participativo seleccionando "Crear nuevo presupuesto" o editar uno existente. Al editar se puede cambiar la fase en la que se encuentra el proceso; este cambio se reflejará en la web. También se pueden crear grupos de partidas presupuestarias y agregar propuestas de inversión que hayan sido creadas previamente por un [gestor](#panel-gestión).
### Perfiles ![perfiles](imgs/icon_profiles.png?raw=true "perfiles") #### Perfiles ![perfiles](imgs/icon_profiles.png?raw=true "perfiles")
#### Organizaciones ##### Organizaciones
En la web cualquier usuario se puede registrar con un perfil individual o como una organización. Los usuarios de organizaciones pueden ser verificados por parte de los administradores, confirmando que quien gestiona el usuario efectivamente representa a esa organización. Una vez se haya realizado el proceso de verificación, por el proceso externo a la web que se haya definido para ello, se pulsa el botón "Verificar" para confimarlo; lo que hará que al lado del nombre de la organización aparezca una etiqueta señalando que es una organización verificada. En la web cualquier usuario se puede registrar con un perfil individual o como una organización. Los usuarios de organizaciones pueden ser verificados por parte de los administradores, confirmando que quien gestiona el usuario efectivamente representa a esa organización. Una vez se haya realizado el proceso de verificación, por el proceso externo a la web que se haya definido para ello, se pulsa el botón "Verificar" para confimarlo; lo que hará que al lado del nombre de la organización aparezca una etiqueta señalando que es una organización verificada.
@@ -137,15 +132,13 @@ Las organizaciones que no aparecen en la lista pueden ser encontradas para actua
Es recomendable revisar regularmente la sección "pendientes". Es recomendable revisar regularmente la sección "pendientes".
##### Cargos Públicos
#### Cargos Públicos
La condición de cargo público no se puede elegir en el registro que se hace desde la web: se asigna directamente desde esta sección. El administrador busca un usuario introduciendo su email en el campo de búsqueda y le asigna el rol de Cargo público. La condición de cargo público no se puede elegir en el registro que se hace desde la web: se asigna directamente desde esta sección. El administrador busca un usuario introduciendo su email en el campo de búsqueda y le asigna el rol de Cargo público.
El cargo público se diferencia del usuario individual únicamente en que al lado de su nombre aparece una etiqueta que le identifica, y cambia ligeramente el estilo de sus comentarios. Esto permite que los usuarios le identifiquen más fácilmente. Al lado de cada cargo vemos la identificación que aparece en su etiqueta, y su nivel (la manera que internamente usa la web para diferenciar entre un tipo de cargos y otros). Pulsando el botón "Editar" al lado del usuario, se puede modificar su información. Los cargos públicos que no aparecen en la lista pueden ser encontrados para actuar sobre ellos por medio del buscador en la parte superior. El cargo público se diferencia del usuario individual únicamente en que al lado de su nombre aparece una etiqueta que le identifica, y cambia ligeramente el estilo de sus comentarios. Esto permite que los usuarios le identifiquen más fácilmente. Al lado de cada cargo vemos la identificación que aparece en su etiqueta, y su nivel (la manera que internamente usa la web para diferenciar entre un tipo de cargos y otros). Pulsando el botón "Editar" al lado del usuario, se puede modificar su información. Los cargos públicos que no aparecen en la lista pueden ser encontrados para actuar sobre ellos por medio del buscador en la parte superior.
##### Moderadores
#### Moderadores
Cualquier usuario registrado en la web puede convertirse en moderador. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como Moderador". Cuando los moderadores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Moderar". Cualquier usuario registrado en la web puede convertirse en moderador. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como Moderador". Cuando los moderadores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Moderar".
@@ -153,31 +146,31 @@ Al seleccionar "Actividad de moderadores" aparece un listado de todas las accion
Esta sección permite que los administradores detecten comportamientos irregulares por parte de moderadores específicos y que por lo tanto puedan corregirlos. Esta sección permite que los administradores detecten comportamientos irregulares por parte de moderadores específicos y que por lo tanto puedan corregirlos.
#### Evaluadores ##### Evaluadores
Cualquier usuario registrado en la web puede convertirse en evaluador. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como evaluador". Cuando los evaluadores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Evaluación". Cualquier usuario registrado en la web puede convertirse en evaluador. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como evaluador". Cuando los evaluadores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Evaluación".
#### Gestores ##### Gestores
Cualquier usuario registrado en la web puede convertirse en gestor. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como gestor". Cuando los gestores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Gestión". Cualquier usuario registrado en la web puede convertirse en gestor. Para asignarle ese rol se introduce su email en el campo de búsqueda y una vez encontrado se asigna con "Añadir como gestor". Cuando los gestores acceden a la web con su usuario ven en la parte superior una nueva sección llamada "Gestión".
### Banners ![banners](imgs/icon_banners.png?raw=true "banners") #### Banners ![banners](imgs/icon_banners.png?raw=true "banners")
Desde el menú "Gestionar banners" se pueden crear banners para hacer anuncios especiales que aparecerán siempre en la parte superior de la web, tanto en el apartado de debates como en el de propuestas. Para crearlo hay que seleccionar "Crear banner" e introducir sus datos y fechas de inicio y fin de publicación en formato ```dd/mm/aaa```. Desde el menú "Gestionar banners" se pueden crear banners para hacer anuncios especiales que aparecerán siempre en la parte superior de la web, tanto en el apartado de debates como en el de propuestas. Para crearlo hay que seleccionar "Crear banner" e introducir sus datos y fechas de inicio y fin de publicación en formato ```dd/mm/aaa```.
Por defecto, en la web sólo aparecerá un banner. Si existen varios banners cuyas fechas indican que deberían estar activos, sólo se visualizará aquel cuya fecha de inicio de publicación sea más antigua. Por defecto, en la web sólo aparecerá un banner. Si existen varios banners cuyas fechas indican que deberían estar activos, sólo se visualizará aquel cuya fecha de inicio de publicación sea más antigua.
### Personalizar sitio ![personalizar sitio](imgs/icon_customize_site.png?raw=true "personalizar sitio") #### Personalizar sitio ![personalizar sitio](imgs/icon_customize_site.png?raw=true "personalizar sitio")
#### Personalizar páginas ##### Personalizar páginas
Las páginas sirven para mostrar cualquier tipo de contenido estático relativo a los procesos de participación. Al crear o editar una página se debe introducir un _slug_ para definir el _permalink_ de esa página en cuestión. Una vez creada, podemos acceder a ella desde el listado, seleccionando "Ver página". Las páginas sirven para mostrar cualquier tipo de contenido estático relativo a los procesos de participación. Al crear o editar una página se debe introducir un _slug_ para definir el _permalink_ de esa página en cuestión. Una vez creada, podemos acceder a ella desde el listado, seleccionando "Ver página".
#### Personalizar imágenes ##### Personalizar imágenes
Desde este panel se definen las imágenes de los elementos corporativos de tu Consul. Desde este panel se definen las imágenes de los elementos corporativos de tu Consul.
#### Personalizar bloques ##### Personalizar bloques
Puedes crear bloques de HTML que se incrustarán en la cabecera o el pie de tu Cónsul. Puedes crear bloques de HTML que se incrustarán en la cabecera o el pie de tu Cónsul.
@@ -191,29 +184,29 @@ Los bloques de la cabecera (top_links) son bloques de enlaces que deben crearse
Los bloques del pie (footer) pueden tener cualquier formato y se pueden utilizar para guardar huellas Javascript, contenido CSS o contenido HTML personalizado. Los bloques del pie (footer) pueden tener cualquier formato y se pueden utilizar para guardar huellas Javascript, contenido CSS o contenido HTML personalizado.
### Gestionar distritos #### Gestionar distritos
Desde este menú se pueden crear los distintos distritos de un municipio con su nombre, coordenadas, código externo y código del censo. Desde este menú se pueden crear los distintos distritos de un municipio con su nombre, coordenadas, código externo y código del censo.
### Hojas de firmas #### Hojas de firmas
Con el fin de registrar apoyos externos a la plataforma, se pueden crear hojas de firmas de Propuestas ciudadanas o Proyectos de inversión introduciendo el ID de la propuesta en cuestión e introduciendo los números de los documentos separados por comas(,). Con el fin de registrar apoyos externos a la plataforma, se pueden crear hojas de firmas de Propuestas ciudadanas o Proyectos de inversión introduciendo el ID de la propuesta en cuestión e introduciendo los números de los documentos separados por comas(,).
### Estadísticas #### Estadísticas
Estadísticas generales del sistema. Estadísticas generales del sistema.
### Configuración global #### Configuración global
Opciones generales de configuración del sistema. Opciones generales de configuración del sistema.
## Panel Moderar ### Panel Moderar
![Panel de moderación](imgs/panel_moderation.png?raw=true "Panel de moderación") ![Panel de moderación](imgs/panel_moderation.png?raw=true "Panel de moderación")
Desde aquí puedes moderar el sistema, a través de las siguientes acciones: Desde aquí puedes moderar el sistema, a través de las siguientes acciones:
### Propuestas / Debates / Comentarios #### Propuestas / Debates / Comentarios
Cuando un usuario marca en una Propuesta/Debate/Comentario la opción de "denunciar como inapropiado", aparecerá en esta lista. Respecto a cada uno aparecerá el título, fecha, número de denuncias (cuántos usuarios diferentes han marcado la opción de denuncia) y el texto de la Propuesta/Debate/Comentario. Cuando un usuario marca en una Propuesta/Debate/Comentario la opción de "denunciar como inapropiado", aparecerá en esta lista. Respecto a cada uno aparecerá el título, fecha, número de denuncias (cuántos usuarios diferentes han marcado la opción de denuncia) y el texto de la Propuesta/Debate/Comentario.
@@ -231,11 +224,11 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones:
Es recomendable revisar regularmente la sección "pendientes". Es recomendable revisar regularmente la sección "pendientes".
### Bloquear usuarios #### Bloquear usuarios
Un buscador nos permite encontrar cualquier usuario introduciendo su nombre de usuario o correo electrónico, y bloquearlo una vez encontrado. Al bloquearlo, el usuario no podrá volver a acceder a la web, y todas sus Propuestas/Debates/Comentarios serán ocultados y dejarán de ser visibles en la web. Un buscador nos permite encontrar cualquier usuario introduciendo su nombre de usuario o correo electrónico, y bloquearlo una vez encontrado. Al bloquearlo, el usuario no podrá volver a acceder a la web, y todas sus Propuestas/Debates/Comentarios serán ocultados y dejarán de ser visibles en la web.
## Panel Gestión ### Panel Gestión
![Panel de gestión](imgs/panel_management.png?raw=true "Panel de gestión") ![Panel de gestión](imgs/panel_management.png?raw=true "Panel de gestión")
@@ -251,8 +244,8 @@ Desde aquí puedes gestionar usuarios a través de las siguientes acciones:
* Imprimir propts. de inversión. * Imprimir propts. de inversión.
* Invitaciones para usuarios. * Invitaciones para usuarios.
# Perfiles de evaluador y presidente de mesa ## Perfiles de evaluador y presidente de mesa
## Panel Evaluación ### Panel Evaluación
## Panel Presidentes de mesa ### Panel Presidentes de mesa

View File

@@ -16,12 +16,13 @@ The preferred method is via rvm:
(only the multi user option installs all dependencies automatically, as we use 'sudo'.) (only the multi user option installs all dependencies automatically, as we use 'sudo'.)
###as local user: ### As local user
``` ```
curl -L https://get.rvm.io | bash -s stable curl -L https://get.rvm.io | bash -s stable
``` ```
###for all system users
### For all system users
``` ```
curl -L https://get.rvm.io | sudo bash -s stable curl -L https://get.rvm.io | sudo bash -s stable
@@ -102,6 +103,7 @@ bundle install
cp config/database.yml.example config/database.yml cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml cp config/secrets.yml.example config/secrets.yml
``` ```
Perhaps it's needed to create a superuser rol with password in postgresql, and write it in */config/database.yml* 'user:' and 'password:' fields. Perhaps it's needed to create a superuser rol with password in postgresql, and write it in */config/database.yml* 'user:' and 'password:' fields.
Also, it seems that postgresql use as default an unix socket for localhost communications. If we encounter problems creating database (connection problems) we can change in */config/database.yml* the line: Also, it seems that postgresql use as default an unix socket for localhost communications. If we encounter problems creating database (connection problems) we can change in */config/database.yml* the line:

View File

@@ -16,12 +16,13 @@ El método recomendado es via rvm:
(sólo la opción multiusuario instala todas las dependencias automáticamente, al usar 'sudo'.) (sólo la opción multiusuario instala todas las dependencias automáticamente, al usar 'sudo'.)
###como usuario local: ### Como usuario local
``` ```
curl -L https://get.rvm.io | bash -s stable curl -L https://get.rvm.io | bash -s stable
``` ```
###para todos los usuarios del sistema:
### Para todos los usuarios del sistema
``` ```
curl -L https://get.rvm.io | sudo bash -s stable curl -L https://get.rvm.io | sudo bash -s stable