MD032 Lists should be surrounded by blank lines
This commit is contained in:
taitus
@@ -31,6 +31,7 @@ When a user visits a page with a language where there is untranslated content, t
|
||||
### Getting started
|
||||
|
||||
In order to use this functionality, the following steps are necessary:
|
||||
|
||||
1. Have an api key to connect to the translation service. For this we need an [Azure account](https://azure.microsoft.com/en-us/)
|
||||
1. Once you are logged into the Azure portal, subscribe to the Translator in Cognitive Service.
|
||||
1. Once you have subscribed to the Translator Text service, you will have access to 2 api keys in the section **Resource Management > Keys and Endpoint** that will be necessary for the configuration of the translation service in your application.
|
||||
@@ -48,6 +49,7 @@ In the previous section we have commented that once subscribed to the translatio
|
||||
#### Activate module
|
||||
|
||||
Once we have the new key in the `secrets.yml` we can now proceed to activate the module. To activate the functionality you must follow 2 steps:
|
||||
|
||||
1. Execute the following command `bin/rake settings:create_remote_translations_setting RAILS_ENV=production`
|
||||
1. Accessing through the administration panel of your application to the section **Configuración > Funcionalidades** and activate module **Traducciones Remotas** as shown below:
|
||||
|
||||
@@ -56,6 +58,7 @@ Once we have the new key in the `secrets.yml` we can now proceed to activate the
|
||||
|
||||
Once we have the api key in our `secrets.yml` and the activated module, users will already be able to use the functionality.
|
||||
We attach some screenshots of how the application interacts with our users:
|
||||
|
||||
* When a user visits a page in a language without translated content, an informative text will appear at the top of the page and a button to request the translation. (**Note:** *If user visit page with a language not supported by the translation service, no text or translation button will be displayed. See section: Available languages for remote translation*)
|
||||
|
||||
|
||||
@@ -86,6 +89,7 @@ The price for each 1 Million characters translated is $10 and there is no fixed
|
||||
Although technical measures have been taken to prevent misuse of this service, we recommend the creation of Alerts offered by Azure so that an Administrator can be notified in the event of detecting unusual use of the service. This service has a cost of $0.10 per month.
|
||||
|
||||
To create an Alert in Azure we must follow the following steps:
|
||||
|
||||
1. Sign in to the **Azure Portal**.
|
||||
1. Access the **Translator** service created earlier.
|
||||
1. Go to **Monitoring > Alerts** in the side menu:
|
||||
@@ -124,6 +128,7 @@ The aim of this feature is to allow users the introduction of dynamic contents i
|
||||
### Enable module
|
||||
|
||||
To activate this feature you must follow 2 steps:
|
||||
|
||||
1. Execute the following command `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (This is only required for already existing intallations, for new consul installations this step is not needed).
|
||||
2. Accessing as administrator user to the administration panel of your Consul application to the section **Configuration > Features** and activating the feature called **Translation Interface** as you can see next:
|
||||
|
||||
@@ -131,10 +136,10 @@ To activate this feature you must follow 2 steps:
|
||||
### Use Cases
|
||||
|
||||
* When the translation interface is active:
|
||||
As you can see in the image below translation interface has two selectors, the first one "Select language" is to switch between enabled languages and the second one "Add language" is to add new languages to the form. Translatable fields appears with a blue background to facilitate users to distinguish between translatable and not translatable fields. Additionally interface provides a link `Remove language` to delete the current language shown at "Select language". If a user accidentally removes a translation he can recover it re-adding it to the form.
|
||||
As you can see in the image below translation interface has two selectors, the firt one "Select language" is to switch between enabled languages and the second one "Add language" is to add new languages to the form. Translatable fields appears with a blue background to facilitate users to distinguish between translatable and not translatable fields. Additionally interface provides a link `Remove language` to delete the current language shown at "Select language". If a user accidentally removes a translation he can recover it re-adding it to the form.
|
||||
This feature is visible during creation and edition of translatable resources.
|
||||
|
||||
|
||||
|
||||
* When the translation interface is disabled:
|
||||
When this feature is deactivated users will see standard forms without translation interface and without translation highlight.
|
||||
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ If we have the feature deactivated we will see an informative text that will ind
|
||||
|
||||
|
||||
To activate the feature you must follow the instructions of the previous image:
|
||||
|
||||
1. Access through the administration panel of your application to the section **Settings > Features** and activate the module **Configure connection to the remote census (SOAP)** as shown below:
|
||||
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
Logged in users can see recommended Debates or Proposals listed with the ordering option "recommendations".
|
||||
|
||||
The list shows, ordered by votes descending, those elements that:
|
||||
|
||||
1. Have tags that interests the user. Being those tags the ones on the proposals that the user follows.
|
||||
2. The user isn't the author.
|
||||
3. In the case of proposals: only those that haven't reached the required threshold of votes, hiding as well those that the user is already following.
|
||||
|
||||
@@ -15,6 +15,7 @@ Consul git repo is hosted at Github.com, we recommend using it for your fork's r
|
||||
## Why make code public?
|
||||
|
||||
We strongly recommend making code public for multiple reasons:
|
||||
|
||||
- **Transparency**: It should be part of the culture of public entities that adopt Consul, as well as any organization or group.
|
||||
- **Support**: If you need technical help, both community and Consul core team will be able to understand and advice by easily seeing involved code.
|
||||
- **Collaboration**: By other professionals, citizens, etc...
|
||||
|
||||
@@ -29,6 +29,7 @@ Run `bundle install` to apply your changes.
|
||||
This guide will assume that you have an Amazon account configured to use S3 and that you created a bucket for your instance of CONSUL. It is highly recommended to use a different bucket for each instance (production, preproduction, staging).
|
||||
|
||||
You will need the following information:
|
||||
|
||||
- the **name** of the S3 bucket
|
||||
- the **region** of the S3 bucket (`eu-central-1` for UE-Francfort for example)
|
||||
- the **hostname** of the S3 bucket (`s3.eu-central-1.amazonaws.com` for Francfort, for example)
|
||||
|
||||
@@ -9,6 +9,7 @@ If you have seen anything wrong in the platform performance or directly in the c
|
||||
Before doing it, **please take some time to check the [existing issues](https://github.com/consul/consul/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before, if you have more details about it you can write a comment in the issue page -a little more help can make a huge difference!
|
||||
|
||||
In order to write a new issue, take into account these few tips to make it easy to read and comprehend:
|
||||
|
||||
- Try to use a descriptive and to-the-point title.
|
||||
- It's a good idea to include some sections -in case they're needed- such as: steps to reproduce the bug, expected behaviour/response, actual response or screenshots.
|
||||
- Also it could be helpful to provide your operating system, browser version and installed plugins.
|
||||
|
||||
@@ -31,6 +31,7 @@ Cuando un usuario accede a una pantalla con un idioma donde parte del contenido
|
||||
### Como empezar
|
||||
|
||||
Para poder utilizar esta funcionalidad es necesario realizar los siguientes pasos:
|
||||
|
||||
1. Disponer de una api key para conectarse con el servicio de traducción. Para ello necesitamos una [cuenta en Azure](https://azure.microsoft.com/es-es/)
|
||||
1. Una vez que haya iniciado sesión en el portal de Azure, subscríbase a Traductor en Cognitive Services.
|
||||
1. Una vez subscrito al servicio de Translator Text, tendrá accesibles 2 api keys en la sección **Administración de recursos > Claves y punto de conexión** que serán necesarias para la configuración del servicio de traducciones en su aplicación.
|
||||
@@ -48,6 +49,7 @@ En el apartado anterior hemos comentado que una vez subscritos al servicio de tr
|
||||
#### Activar funcionalidad
|
||||
|
||||
Una vez disponemos de la nueva key en el `secrets.yml` ya podemos proceder a activar la funcionalidad. Para activar la funcionalidad deberá realizar 2 pasos:
|
||||
|
||||
1. Ejecutar el siguiente comando `bin/rake settings:create_remote_translations_setting RAILS_ENV=production`
|
||||
1. Acceder a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activar el módulo de **Traducciones Remotas** como se puede ver a continuación:
|
||||
|
||||
@@ -56,6 +58,7 @@ Una vez disponemos de la nueva key en el `secrets.yml` ya podemos proceder a act
|
||||
|
||||
Una vez tenemos la api key en nuestro `secrets.yml` y el módulo activado, los usuarios ya podrán utilizar la funcionalidad.
|
||||
Para aclarar el funcionamiento, se adjuntan unos pantallazos de como interactua la aplicación con nuestros usuarios:
|
||||
|
||||
* Cuando un usuario accede a una pantalla en un idioma en el que no están disponibles todas las traducciones, le aparecerá un texto en la parte superior de la pantalla y un botón para poder solicitar la traducción. (**Nota:** *En el caso de acceder con un idioma no soportado por el servicio de traducción no se mostrará ningún texto ni botón de traducción. Ver sección: Idiomas disponibles para la traducción remota*)
|
||||
|
||||
|
||||
@@ -86,6 +89,7 @@ El precio por cada 1 Millón de caracteres traducidos asciende a 10 $ y sin ning
|
||||
Aunque se han tomado medidas técnicas para evitar un mal uso de este servicio, recomendamos la creación de Alertas que ofrece Azure para que un Administrador pueda ser notificado en el caso de detectar un uso fuera de lo común del servicio. Este servicio tiene un coste de 0,10 $ al mes.
|
||||
|
||||
Para crear una Alerta en Azure debemos seguir los siguientes pasos:
|
||||
|
||||
1. Inicie sesión en **Azure Portal**.
|
||||
1. Accede al servicio **Traductor** creado anteriormente.
|
||||
1. Accede en el menu lateral a **Supervisión > Alertas**:
|
||||
@@ -124,6 +128,7 @@ Esta funcionalidad permite a los usuarios introducir contenidos dinámicos en di
|
||||
### Activar funcionalidad
|
||||
|
||||
Para activar la funcionalidad deberá realizar 2 pasos:
|
||||
|
||||
1. Ejecutar el siguiente comando `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (Este paso sólo es necesario para instalaciones de Consul existentes que incorporan esta funcionalidad, para nuevas instalaciones no es necesario)
|
||||
1. Accedediendo como usuario administrador a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activando el módulo de **Interfaz de traducción** como se puede ver a continuación:
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ Si tenemos la funcionalidad desactivada veremos un texto informativo que nos ind
|
||||
|
||||
|
||||
Para activar la funcionalidad deberá seguir las instrucciones de la imagen anterior:
|
||||
|
||||
1. Acceder a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activar el módulo de **Configurar conexión al censo remoto (SOAP)** como se puede ver a continuación:
|
||||
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
Para Debates y Propuestas los usuarios logueados pueden encontrar elementos recomendados usando el filtro de ordenación "Recomendaciones".
|
||||
|
||||
En este listado se muestran, ordenados por votos de forma descendiente, aquellos elementos que:
|
||||
|
||||
1. Tengan etiquetas que interesen al usuario. Siendo las etiquetas de su interés aquellas usadas en propuestas que ha seguido.
|
||||
2. El usuario no sea el autor de los mismos.
|
||||
3. Sólo en el caso de las propuestas: únicamente se muestran aquellas que aún no hayan llegado al umbral de votos requerido, ocultándose además aquellas que el usuario este siguiendo.
|
||||
|
||||
@@ -15,6 +15,7 @@ El repositorio git de Consul está hospedado en Github.com, recomendamos lo uses
|
||||
## ¿Porqué hacer el código público?
|
||||
|
||||
Recomendamos publicar el código por varias razones:
|
||||
|
||||
- **Transparencia**: Debería ser parte de la cultura de aquellas entidades públicas que adopten Consul, así como cualquier organización o grupo.
|
||||
- **Soporte**: Si necesitas ayuda técnica, el resto de la comunidad o el equipo de Consul podrán entender y aconsejar mas fácilmente al ver el código implicado.
|
||||
- **Colaboración**: Por parte de otros profesionales, ciudadanos, etc...
|
||||
|
||||
@@ -9,6 +9,7 @@ Si has visto algún error en la plataforma o directamente en el código, te anim
|
||||
Antes de hacerlo, **por favor tómate un tiempo para comprobar los [issues ya existentes](https://github.com/consul/consul/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página del issue ‑¡un poco de ayuda puede marcar una gran diferencia!
|
||||
|
||||
Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo más fácil de leer y comprender:
|
||||
|
||||
- Intenta usar un título descriptivo.
|
||||
- Es buena idea incluir algunas secciones -en caso de que sean necesarias- como los pasos para reproducir el error, el comportamiento o respuesta que cabría esperar, la respuesta que devuelve o capturas de pantalla.
|
||||
- También puede ser de ayuda incluir en la descripción tu sistema operativo, versión del navegador que usaste y posibles plugins instalados.
|
||||
@@ -18,6 +19,7 @@ Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo m
|
||||
[Los issues en Consul](https://github.com/consul/consul/issues) con la etiqueta `PRs-welcome` son funcionalidades bien definidas que están listas para ser implementadas por cualquiera que se ofrezca a ello. Por otra parte, la etiqueta `not-ready` indica las funcionalidades o cambios que aún están pendientes de concretar, por lo que recomendamos no intentar resolverlos hasta que los/as administradores/as lleguen a una resolución.
|
||||
|
||||
Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los cambios que vayas a hacer:
|
||||
|
||||
- Primero, añade un comentario en el issue para notificar que vas resolverlo. Si el issue tiene a alguien asignado significa que ya hay alguien encargado de él.
|
||||
- Crea un fork del proyecto.
|
||||
- Crea una rama de funcionalidad basada en la rama `master`. Para identificarla más fácilmente, puedes nombrarla con el número del issue seguido de un nombre conciso y descriptivo (por ejemplo: `123-fix_proposals_link`).
|
||||
|
||||
Reference in New Issue
Block a user