From aa405abf63710eb48c2d2acc3927f09d8c32001b Mon Sep 17 00:00:00 2001 From: Bertocq Date: Wed, 14 Jun 2017 18:13:36 +0200 Subject: [PATCH 01/12] Add markdownlinter gem to development group --- Gemfile | 1 + Gemfile.lock | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/Gemfile b/Gemfile index 8444d6748..9b477594c 100644 --- a/Gemfile +++ b/Gemfile @@ -104,6 +104,7 @@ group :test do end group :development do + gem 'mdl', require: false # Access an IRB console on exception pages or by using <%= console %> in views gem 'web-console', '3.3.0' end diff --git a/Gemfile.lock b/Gemfile.lock index 800b14763..0bf5694e9 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -224,6 +224,7 @@ GEM knapsack (1.13.3) rake timecop (>= 0.1.0) + kramdown (1.13.2) launchy (2.4.3) addressable (~> 2.3) letter_opener (1.4.1) @@ -236,12 +237,18 @@ GEM nokogiri (>= 1.5.9) mail (2.6.6) 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-data (~> 3.2015) mime-types-data (3.2016.0521) mimemagic (0.3.2) mini_portile2 (2.1.0) minitest (5.10.1) + mixlib-cli (1.7.0) + mixlib-config (2.2.4) multi_json (1.12.1) multi_xml (0.6.0) multipart-post (2.0.0) @@ -514,6 +521,7 @@ DEPENDENCIES knapsack launchy letter_opener_web (~> 1.3.1) + mdl newrelic_rpm (~> 4.1.0.333) omniauth omniauth-facebook (~> 4.0.0) From 5c8faa26540e582509e080f5f13a1c29e799fd94 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Wed, 14 Jun 2017 18:14:02 +0200 Subject: [PATCH 02/12] Add markdownlinter config file --- .mdlrc | 1 + 1 file changed, 1 insertion(+) create mode 100644 .mdlrc diff --git a/.mdlrc b/.mdlrc new file mode 100644 index 000000000..5071bdb6d --- /dev/null +++ b/.mdlrc @@ -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" From 41a2cf5bf33ceabf072b530f61b9a7fd3629fd0c Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:47:25 +0200 Subject: [PATCH 03/12] Fix MD002 First header should be a top level header issues on Contributing md files --- CONTRIBUTING_EN.md | 2 ++ CONTRIBUTING_ES.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md index 17f93bc63..2c5f6a591 100644 --- a/CONTRIBUTING_EN.md +++ b/CONTRIBUTING_EN.md @@ -1,3 +1,5 @@ +# How to Contribute to this Project + ## Team members * Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000) diff --git a/CONTRIBUTING_ES.md b/CONTRIBUTING_ES.md index aaee9ec92..6be8be9cd 100644 --- a/CONTRIBUTING_ES.md +++ b/CONTRIBUTING_ES.md @@ -1,3 +1,5 @@ +# Cómo Contribuir a este Projecto + ## Miembros del equipo * Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000) From 889af958be8ebad1659e8459062340094e685f9b Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:49:26 +0200 Subject: [PATCH 04/12] Fix MD012 Multiple consecutive blank lines across multiple markdown files --- CUSTOMIZE_EN.md | 2 -- CUSTOMIZE_ES.md | 2 -- README_ES.md | 1 - doc/README.md | 8 -------- 4 files changed, 13 deletions(-) diff --git a/CUSTOMIZE_EN.md b/CUSTOMIZE_EN.md index 552008f38..75b10a6cf 100644 --- a/CUSTOMIZE_EN.md +++ b/CUSTOMIZE_EN.md @@ -125,7 +125,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`: - ```ruby require 'rails_helper' @@ -181,7 +180,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: - ```ruby module Consul class Application < Rails::Application diff --git a/CUSTOMIZE_ES.md b/CUSTOMIZE_ES.md index 224efc2a3..66f0904f8 100644 --- a/CUSTOMIZE_ES.md +++ b/CUSTOMIZE_ES.md @@ -125,7 +125,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`: - ```ruby require 'rails_helper' @@ -181,7 +180,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: - ```ruby module Consul class Application < Rails::Application diff --git a/README_ES.md b/README_ES.md index bbe821608..af7f79bfe 100644 --- a/README_ES.md +++ b/README_ES.md @@ -15,7 +15,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) - 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 diff --git a/doc/README.md b/doc/README.md index c3aa2467e..da463b120 100644 --- a/doc/README.md +++ b/doc/README.md @@ -74,7 +74,6 @@ Los temas (también llamados tags, o etiquetas) son palabras que definen los usu * 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. - ### Contenido moderado ![contenido moderado](imgs/icon_moderated_content.png?raw=true "contenido moderado") #### Propuestas/Debates/Comentarios ocultos @@ -88,7 +87,6 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones: "Pen Es recomendable revisar regularmente la sección "Pendientes". - ### 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. @@ -103,24 +101,20 @@ 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. - #### 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". 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 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 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") 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). @@ -137,14 +131,12 @@ Las organizaciones que no aparecen en la lista pueden ser encontradas para actua Es recomendable revisar regularmente la sección "pendientes". - #### 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. 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 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". From 4ee3dc4a6d45c4609df8a94eb15937f49411c62a Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:50:02 +0200 Subject: [PATCH 05/12] Fix MD014 Dollar signs used before commands without showing output on customize markdown files --- CUSTOMIZE_EN.md | 2 +- CUSTOMIZE_ES.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CUSTOMIZE_EN.md b/CUSTOMIZE_EN.md index 75b10a6cf..5b35d6c8f 100644 --- a/CUSTOMIZE_EN.md +++ b/CUSTOMIZE_EN.md @@ -208,7 +208,7 @@ TODO 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: diff --git a/CUSTOMIZE_ES.md b/CUSTOMIZE_ES.md index 66f0904f8..72bac906f 100644 --- a/CUSTOMIZE_ES.md +++ b/CUSTOMIZE_ES.md @@ -208,7 +208,7 @@ TODO 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 From 438c462d36dd4a8898e3a04a477b5775fef04700 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:51:13 +0200 Subject: [PATCH 06/12] Fix MD009 Trailing spaces on markdown files --- doc/README.md | 6 +++--- doc/en/dev_test_setup_linux.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/README.md b/doc/README.md index da463b120..f3f112387 100644 --- a/doc/README.md +++ b/doc/README.md @@ -54,7 +54,7 @@ Dentro de su perfil ("Mi cuenta" en el menú superior) cada usuario puede config # 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). @@ -68,7 +68,7 @@ Desde aquí puedes administrar el sistema, a través de los siguientes menús: #### 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: * Crear temas nuevos * Eliminar temas inapropiados @@ -141,7 +141,7 @@ El cargo público se diferencia del usuario individual únicamente en que al lad 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". -Al seleccionar "Actividad de moderadores" aparece un listado de todas las acciones que realizan los moderadores: ocultar/mostrar Propuestas/Debates/Comentarios y bloquear usuarios. En la columna "Acción" comprobamos si la acción corresponde con ocultar o con volver a mostrar (restaurar) elementos o con bloquear usuarios. En las demás columnas tenemos el tipo de elemento, el contenido del elemento y el moderador o administrador que ha realizado la acción. +Al seleccionar "Actividad de moderadores" aparece un listado de todas las acciones que realizan los moderadores: ocultar/mostrar Propuestas/Debates/Comentarios y bloquear usuarios. En la columna "Acción" comprobamos si la acción corresponde con ocultar o con volver a mostrar (restaurar) elementos o con bloquear usuarios. En las demás columnas tenemos el tipo de elemento, el contenido del elemento y el moderador o administrador que ha realizado la acción. Esta sección permite que los administradores detecten comportamientos irregulares por parte de moderadores específicos y que por lo tanto puedan corregirlos. diff --git a/doc/en/dev_test_setup_linux.md b/doc/en/dev_test_setup_linux.md index df0dbb26a..218ec7ad7 100644 --- a/doc/en/dev_test_setup_linux.md +++ b/doc/en/dev_test_setup_linux.md @@ -112,8 +112,8 @@ host: localhost for: -``` -host: /var/run/postgresql +``` +host: /var/run/postgresql ``` After this: From 42b7fefe17e660c40c110e4c4f798a3e10f41ebd Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:53:56 +0200 Subject: [PATCH 07/12] Fix MD025 Multiple top level headers in the same document on doc Readme document, by adding extra level on other headers --- doc/README.md | 74 +++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/README.md b/doc/README.md index f3f112387..525b30926 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,7 +6,7 @@ * [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) -# Funcionalidades +## Funcionalidades Actualmente Consul soporta: @@ -17,7 +17,7 @@ Actualmente Consul soporta: * Comentarios anidados en debates y propuestas. * 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. @@ -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") -# 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: @@ -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 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. 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") 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: @@ -74,9 +74,9 @@ Los temas (también llamados tags, o etiquetas) son palabras que definen los usu * 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. -### 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. @@ -87,13 +87,13 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones: "Pen 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. * 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. -### 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). @@ -101,27 +101,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. -#### 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". 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". -#### 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. -### 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). -### 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. @@ -131,13 +131,13 @@ Las organizaciones que no aparecen en la lista pueden ser encontradas para actua 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. 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". @@ -145,31 +145,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. -#### 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". -#### 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". -### 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```. 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". -#### Personalizar imágenes +##### Personalizar imágenes 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. @@ -183,29 +183,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. -### 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. -### 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(,). -### Estadísticas +#### Estadísticas Estadísticas generales del sistema. -### Configuración global +#### Configuración global 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") 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. @@ -223,11 +223,11 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones: 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. -## Panel Gestión +### Panel Gestión ![Panel de gestión](imgs/panel_management.png?raw=true "Panel de gestión") @@ -243,8 +243,8 @@ Desde aquí puedes gestionar usuarios a través de las siguientes acciones: * Imprimir propts. de inversión. * 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 From 5ce371390753ec1ab93414d5cdba88d82912ced4 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:54:45 +0200 Subject: [PATCH 08/12] Fix MD018 No space after hash on atx style header on markdown files --- doc/en/dev_test_setup_linux.md | 4 ++-- doc/es/dev_test_setup_linux.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/en/dev_test_setup_linux.md b/doc/en/dev_test_setup_linux.md index 218ec7ad7..878a501a2 100644 --- a/doc/en/dev_test_setup_linux.md +++ b/doc/en/dev_test_setup_linux.md @@ -16,12 +16,12 @@ The preferred method is via rvm: (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 ``` -###for all system users +### For all system users ``` curl -L https://get.rvm.io | sudo bash -s stable diff --git a/doc/es/dev_test_setup_linux.md b/doc/es/dev_test_setup_linux.md index 170871913..dc9c92225 100644 --- a/doc/es/dev_test_setup_linux.md +++ b/doc/es/dev_test_setup_linux.md @@ -16,12 +16,12 @@ El método recomendado es via rvm: (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 ``` -###para todos los usuarios del sistema: +### Para todos los usuarios del sistema: ``` curl -L https://get.rvm.io | sudo bash -s stable From a1a2d3dc1f70d089484dbc167fe6898f752c1905 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:56:38 +0200 Subject: [PATCH 09/12] Fix MD031 Fenced code blocks should be surrounded by blank lines across multiple markdown files --- CUSTOMIZE_EN.md | 1 + CUSTOMIZE_ES.md | 1 + README.md | 1 + README_ES.md | 1 + doc/en/dev_test_setup_linux.md | 2 ++ doc/es/dev_test_setup_linux.md | 1 + 6 files changed, 7 insertions(+) diff --git a/CUSTOMIZE_EN.md b/CUSTOMIZE_EN.md index 5b35d6c8f..13e5d2355 100644 --- a/CUSTOMIZE_EN.md +++ b/CUSTOMIZE_EN.md @@ -68,6 +68,7 @@ In order to make changes to any CSS selector (custom style sheets), you can add 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: ```css diff --git a/CUSTOMIZE_ES.md b/CUSTOMIZE_ES.md index 72bac906f..e3edf6c2b 100644 --- a/CUSTOMIZE_ES.md +++ b/CUSTOMIZE_ES.md @@ -68,6 +68,7 @@ Si quieres cambiar algun selector CSS (de las hojas de estilo) puedes hacerlo en 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: ```css diff --git a/README.md b/README.md index 6a1bb19ac..e340de37a 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ RAILS_ENV=test rake db:setup ``` Run the app locally: + ``` bin/rails s diff --git a/README_ES.md b/README_ES.md index af7f79bfe..a6b91d0f9 100644 --- a/README_ES.md +++ b/README_ES.md @@ -45,6 +45,7 @@ RAILS_ENV=test rake db:setup ``` Para ejecutar la aplicación en local: + ``` bin/rails s ``` diff --git a/doc/en/dev_test_setup_linux.md b/doc/en/dev_test_setup_linux.md index 878a501a2..09f238af1 100644 --- a/doc/en/dev_test_setup_linux.md +++ b/doc/en/dev_test_setup_linux.md @@ -21,6 +21,7 @@ The preferred method is via rvm: ``` curl -L https://get.rvm.io | bash -s stable ``` + ### For all system users ``` @@ -102,6 +103,7 @@ bundle install cp config/database.yml.example config/database.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. 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: diff --git a/doc/es/dev_test_setup_linux.md b/doc/es/dev_test_setup_linux.md index dc9c92225..dc27585fc 100644 --- a/doc/es/dev_test_setup_linux.md +++ b/doc/es/dev_test_setup_linux.md @@ -21,6 +21,7 @@ El método recomendado es via rvm: ``` curl -L https://get.rvm.io | bash -s stable ``` + ### Para todos los usuarios del sistema: ``` From c903f555b33939d7553840d98bd4425bf729e029 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:57:19 +0200 Subject: [PATCH 10/12] Fix MD022 Headers should be surrounded by blank lines --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e340de37a..aa17edef4 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,7 @@ But for some actions like voting, you will need a verified user, the seeds file **pass:** 12345678 ### Customization + Read more on documentation: * English: [CUSTOMIZE_EN.md](CUSTOMIZE_EN.md) * Spanish: [CUSTOMIZE_ES.md](CUSTOMIZE_ES.md) From fbb74a4d052d7efd007d2a6e90a7e9afb6e4e982 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:57:46 +0200 Subject: [PATCH 11/12] Fix MD032 Lists should be surrounded by blank lines on readme files --- README.md | 1 + doc/README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index aa17edef4..421ecaa7d 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,7 @@ But for some actions like voting, you will need a verified user, the seeds file ### Customization Read more on documentation: + * English: [CUSTOMIZE_EN.md](CUSTOMIZE_EN.md) * Spanish: [CUSTOMIZE_ES.md](CUSTOMIZE_ES.md) diff --git a/doc/README.md b/doc/README.md index 525b30926..7e14c378a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -90,6 +90,7 @@ Es recomendable revisar regularmente la sección "Pendientes". #### 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. + * 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. From 2a339e2155b7573266d0083b75e413a2e3990ae1 Mon Sep 17 00:00:00 2001 From: Bertocq Date: Thu, 15 Jun 2017 23:58:19 +0200 Subject: [PATCH 12/12] Fix MD026 Trailing punctuation in header on dev test setup markdown files --- doc/en/dev_test_setup_linux.md | 2 +- doc/es/dev_test_setup_linux.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/en/dev_test_setup_linux.md b/doc/en/dev_test_setup_linux.md index 09f238af1..5e4a1195a 100644 --- a/doc/en/dev_test_setup_linux.md +++ b/doc/en/dev_test_setup_linux.md @@ -16,7 +16,7 @@ The preferred method is via rvm: (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 diff --git a/doc/es/dev_test_setup_linux.md b/doc/es/dev_test_setup_linux.md index dc27585fc..b5c50eff0 100644 --- a/doc/es/dev_test_setup_linux.md +++ b/doc/es/dev_test_setup_linux.md @@ -16,13 +16,13 @@ El método recomendado es via rvm: (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 ``` -### Para todos los usuarios del sistema: +### Para todos los usuarios del sistema ``` curl -L https://get.rvm.io | sudo bash -s stable