Fixing docs Markdown format and images routes

This commit is contained in:
Andrés Lucena
2016-07-14 18:25:25 +02:00
committed by GitHub
parent e8b73947ef
commit c37a96c404

View File

@@ -1,4 +1,4 @@
h1. Funcionalidades
# Funcionalidades
Actualmente Consul soporta:
@@ -9,11 +9,11 @@ Actualmente Consul soporta:
* Comentarios anidados en debates y propuestas.
* Presupuestos participativos a través de distintas fases.
h1. Usuario
# 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
![Registro de usuario](doc/imgs/user_registration.png?raw=true "Registro de usuario")
![Registro de usuario](imgs/user_registration.png "Registro de usuario")
Por otro lado también se puede habilitar el registro a través de servicios externos como Twitter, Facebook y Google. Para esto hace falta tener la configuración habilitada en Settings y las claves y secretos de estos servicios en el fichero *config/secrets.yml*.
@@ -28,13 +28,13 @@ Por otro lado también se puede habilitar el registro a través de servicios ext
Una vez el usuario ha iniciado sesión le aparecerá la posibilidad de verificar su cuenta, a través de una conexión con el padrón municipal.
![Verificación de usuario](doc/imgs/user_preverification.png?raw=true "Verificación de usuario")
![Verificación de usuario](imgs/user_preverification.png?raw=true "Verificación de usuario")
Para esta funcionalidad hace falta que el padrón municipal soporte la posibilidad de conexión a través de una API, puedes ver un ejemplo en *lib/census_api.rb*.
![Verificación de usuario](doc/imgs/user_verification.png?raw=true "Verificación de usuario")
![Verificación de usuario](imgs/user_verification.png?raw=true "Verificación de usuario")
h1. Perfil de usuario
# Perfil de usuario
Dentro de su perfil 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:
@@ -44,21 +44,21 @@ Dentro de su perfil cada usuario puede configurar si quiere mostrar públicament
* Recibir resumen de notificaciones sobre propuestas
* Recibir emails con mensajes privados
h1. Paneles de administración, gestión y moderación
# Paneles de administración, gestión y moderación
Consul cuenta con tres perfiles de usuario diferenciados para hacer tareas de revisión y moderación de los contenidos. Se detallan a continuación:
h2. Administración
## Administración
![Panel de administración](doc/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 las siguientes acciones:
h3. Temas de debate
### Temas de debate
Los temas (también llamadas tags, o etiquetas) de debate son palabras que definen los usuarios al crear debates, para catalogarlos (ej: sanidad, movilidad, arganzuela, ...). Aquí se pueden eliminar temas inapropiados, o marcarlos para ser propuestos al crear debates (cada usuario puede definir los que quiera, pero se le sugieren algunos que nos parecen útiles como catalogación por defecto; aquí se puede cambiar cuáles se sugieren)
h3. Propuestas/Debates/Comentarios ocultos
### Propuestas/Debates/Comentarios ocultos
Cuando un moderador o un administrador oculta una Propuesta/Debate/Comentario aparecerá en esta lista. De esta forma los administradores pueden revisar que se ha ocultado el elemento adecuado.
* Al pulsar Confirmar se acepta el que se haya ocultado, se considera que se ha hecho correctamente.
@@ -67,11 +67,11 @@ Para facilitar la gestión, arriba encontramos un filtro con las secciones: "pen
Es recomendable revisar regularmente la sección "pendientes".
h3. Usuarios bloqueados
### Usuarios bloqueados
Cuando un moderador o un administrador bloquea a un usuario aparecerá en esta lista. Al bloquear a un usuario, éste deja de poder utilizarlo para ninguna acción de la web. Los administradores pueden desbloquearlos pulsando el botón al lado del nombre del usuario en la lista.
h3. Organizaciones
### Organizaciones
En la web hay dos tipos de usuarios: individuales y organizaciones. Cualquier persona puede crear usuarios de un tipo o de otro en la propia web. 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.
@@ -83,33 +83,33 @@ Las organizaciones que no aparecen en la lista pueden ser encontradas para actua
Es recomendable revisar regularmente la sección "pendientes".
h3. Cargos Públicos
### Cargos Públicos
En la web, los usuarios individuales pueden ser usuarios normales, o cargos públicos. Estos últimos se diferencian de los primeros únicamente en que al lado de sus nombres aparece una etiqueta que les identifica, y cambia ligeramente el estilo de sus comentarios. Esto permite que los usuarios les identifiquen más fácilmente. Al lado de cada usuario 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.
h3. Moderadores
### Moderadores
Mediante el buscador de la parte superior se pueden buscar usuarios, para activarlos o desactivarlos como moderadores de la web. Los moderadores al acceder a la web con su usuario ven en la parte superior una nueva sección llamada "Moderar"
h3. Actividad de moderadores
### Actividad de moderadores
En esta sección se va guardando todas las acciones que realizan los moderadores o los administradores respecto a la moderación: 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.
h3. Configuración Global
### Configuración Global
Opciones generales de configuración del sistema.
h3. Estadísticas
### Estadísticas
Estadísticas generales del sistema.
h2. Moderación
## Moderación
![Panel de moderación](doc/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:
h3. 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.
@@ -126,13 +126,13 @@ Marcados como revisados: los que algún moderador ha marcado como revisados y po
Es recomendable revisar regularmente la sección "pendientes".
h3. 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.
h2. Gestión
## Gestión
![Panel de gestión](doc/imgs/panel_management.png?raw=true "Panel de gestión")
![Panel de gestión](imgs/panel_management.png?raw=true "Panel de gestión")
Desde aquí puedes gestionar usuarios a través de las siguientes acciones: