consul/grecia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #5697 from consuldemocracy/recommendation_docs

Browse Source 
Update recommendations documentation
This commit is contained in:
Javi Martín
2024-09-20 14:32:27 +02:00
committed by GitHub
parent d5fd7b77fd a693258e41
commit 8277336a7e
4 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/SUMMARY.md
View File

@@ -46,7 +46,7 @@
* [Technical Features](features/features.md) * [Technical Features](features/features.md)
* [OAuth](features/oauth.md) * [OAuth](features/oauth.md)
* [GraphQL](features/graphql.md) * [GraphQL](features/graphql.md)
* [Recommendations](features/recommendations.md) * [Debates and proposals recommendations](features/recommendations.md)
* [Configure Census Connection](features/census_configuration.md) * [Configure Census Connection](features/census_configuration.md)
* [Local Census](features/local_census.md) * [Local Census](features/local_census.md)
* [Multitenancy](features/multitenancy.md) * [Multitenancy](features/multitenancy.md)

30
docs/en/features/recommendations.md
View File

@@ -1,29 +1,29 @@
# Debates & Proposals Recommendations # Debates and proposals recommendations
Logged in users can see recommended Debates or Proposals listed with the ordering option "recommendations". Logged in users can see recommended debates or proposals by sorting them by "recommendations".
The list shows, ordered by votes descending, those elements that: The sorted list shows, ordered by votes in descending order, those elements that:
1. Have tags that interests the user. Being those tags the ones on the proposals that the user follows. 1. Have tags that interest the user. Those tags are the ones on the proposals that the user follows.
2. The user isn't the author. 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. 3. In the case of proposals: only those that haven't reached the required threshold of votes and the user isn't already following.
## How to try it ## How to try this feature
In our local installation, if we haven't logged in, we can check at <http://localhost:3000/proposals> that the "recommendations" ordering isn't present: In our local installation, if we haven't logged in, we can check at <http://localhost:3000/proposals> that the "recommendations" sorting option isn't present:
![Recommendations not logged in](../../img/recommendations/recommendations_not_logged_in.jpg) ![The sorting options don't include "recommendations"](../../img/recommendations/recommendations_not_logged_in.jpg)
Once we log in we see the menu, but because we don't aren't following any proposals we get the message "Follow proposals so we can give you recommendations" at <http://localhost:3000/proposals?locale=en&order=recommendations&page=1> Once we log in we see the menu, but since we aren't following any proposals we get the message "Follow proposals so we can give you recommendations" at <http://localhost:3000/proposals?locale=en&order=recommendations&page=1>
![Recommendations no follows](../../img/recommendations/recommendations_no_follows.jpg) ![Recommendations are empty](../../img/recommendations/recommendations_no_follows.jpg)
After following any proposal with the "Follow citizen proposal" on the side menu: Follow any proposal using the "Follow citizen proposal" button on the side menu:
![Recommendations follow button](../../img/recommendations/recommendations_follow_button.jpg) ![Button to follow a citizen proposal](../../img/recommendations/recommendations_follow_button.jpg)
We can finally see some recommendations: Now we can finally see some recommendations:
![Recommendations with follows](../../img/recommendations/recommendations_with_follows.jpg) ![List of recommendations](../../img/recommendations/recommendations_with_follows.jpg)
The feature works the same for debates The feature works the same way for debates.

2
docs/es/SUMMARY.md
View File

@@ -46,7 +46,7 @@
* [Funcionalidades Técnicas](features/features.md) * [Funcionalidades Técnicas](features/features.md)
* [OAuth](features/oauth.md) * [OAuth](features/oauth.md)
* [GraphQL](features/graphql.md) * [GraphQL](features/graphql.md)
* [Recomendaciones](features/recommendations.md) * [Recomendaciones de debates y propuestas](features/recommendations.md)
* [Configurar conexión con el Censo](features/census_configuration.md) * [Configurar conexión con el Censo](features/census_configuration.md)
* [Local Census](features/local_census.md) * [Local Census](features/local_census.md)
* [Multitenancy](features/multitenancy.md) * [Multitenancy](features/multitenancy.md)

24
docs/es/features/recommendations.md
View File

@@ -1,29 +1,29 @@
# Recomendaciones de Debates y Propuestas # Recomendaciones de debates y propuestas
Para Debates y Propuestas los usuarios logueados pueden encontrar elementos recomendados usando el filtro de ordenación "Recomendaciones". Para debates y propuestas, los usuarios identificados 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: 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. 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. 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. 3. Solamente en el caso de las propuestas: únicamente se muestran aquellas que aún no hayan llegado al umbral de votos requerido, siempre que el usuario no las esté siguiendo ya.
## Cómo probar la funcionalidad ## Cómo probar la funcionalidad
En nuestra instalación en local, si no hemos iniciado sesión, podemos comprobar visitando <http://localhost:3000/proposals> que no aparece la opción de ordenación "Recomendaciones" En nuestra instalación local, si no hemos iniciado sesión, podemos comprobar visitando <http://localhost:3000/proposals> que no aparece la opción de ordenación "Recomendaciones":
![Recommendations not logged in](../../img/recommendations/recommendations_not_logged_in.jpg) ![Los filtros de ordenación no incluyen "recomendaciones"](../../img/recommendations/recommendations_not_logged_in.jpg)
Una vez iniciada sesión aparece el menú de ordenación, pero al no tener intereses nos muestra un mensaje "Sigue propuestas para que podamos darte recomendaciones" si lo visitamos en <http://localhost:3000/proposals?locale=en&order=recommendations&page=1> Una vez iniciada la sesión, aparece el menú de ordenación, pero al no tener intereses nos muestra un mensaje "Sigue propuestas para que podamos darte recomendaciones" si lo visitamos en <http://localhost:3000/proposals?locale=en&order=recommendations&page=1>
![Recommendations no follows](../../img/recommendations/recommendations_no_follows.jpg) ![No hay recomendaciones](../../img/recommendations/recommendations_no_follows.jpg)
Tras seguir una propuesta cualquiera con el botón de "Seguir propuesta ciudadana" que aparece en el menu lateral: Sigue una propuesta cualquiera con el botón de "Seguir propuesta ciudadana" que aparece en el menu lateral:
![Recommendations follow button](../../img/recommendations/recommendations_follow_button.jpg) ![Botón para seguir una propuesta](../../img/recommendations/recommendations_follow_button.jpg)
Podemos comprobar que tenemos recomendaciones: Ahora podemos comprobar que tenemos recomendaciones:
![Recommendations with follows](../../img/recommendations/recommendations_with_follows.jpg) ![Lista de recomendaciones](../../img/recommendations/recommendations_with_follows.jpg)
La funcionalidad es similar en el menú de debates. La funcionalidad es similar en la sección de debates.