diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index c58551129..f55ad93dd 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -30,10 +30,13 @@ * [Overwritting Application](customization/overwritting.md) * [Adding new features](customization/new_features.md) -### Features +### Technical Features * [OAuth](features/oauth.md) * [GraphQL](features/graphql.md) +## User Features +* [Recommendations](features/recommendations.md) + ### Open Source project * [Code of conduct](open_source/code_of_conduct.md) * [Contributing](open_source/contributing.md) diff --git a/docs/en/features/recomendations.md b/docs/en/features/recomendations.md new file mode 100644 index 000000000..495fe24e0 --- /dev/null +++ b/docs/en/features/recomendations.md @@ -0,0 +1,28 @@ +# Debates & Proposals Recommendations + +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. + +## How to try it + +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: + +![Recommendations not logged in](../../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 + +![Recommendations no follows](../../img/recommendations/recommendations_no_follows.jpg) + +After following any proposal with the "Follow citizen proposal" on the side menu: + +![Recommendations follow button](../../img/recommendations/recommendations_follow_button.jpg) + +We can finally see some recommendations: + +![Recommendations with follows](../../img/recommendations/recommendations_with_follows.jpg) + +The feature works the same for debates diff --git a/docs/es/SUMMARY.md b/docs/es/SUMMARY.md index 7313513b4..e039d2483 100644 --- a/docs/es/SUMMARY.md +++ b/docs/es/SUMMARY.md @@ -30,10 +30,13 @@ * [Adaptar la aplicación](customization/overwritting.md) * [Añadir nuevas funcionalidades](customization/new_features.md) -### Funcionalidades +### Funcionalidades Técnicas * [OAuth](features/oauth.md) * [GraphQL](features/graphql.md) +## Funcionalidades de Usuario +* [Recomendaciones](features/recommendations.md) + ### Proyecto Open Source * [Código de conducta](open_source/code_of_conduct.md) * [Contribuciones](open_source/contributing.md) diff --git a/docs/es/features/recommendations.md b/docs/es/features/recommendations.md new file mode 100644 index 000000000..e17635ac4 --- /dev/null +++ b/docs/es/features/recommendations.md @@ -0,0 +1,28 @@ +# Recomendaciones de Debates y Propuestas + +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. + +## 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" + +![Recommendations not logged in](../../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 + +![Recommendations no follows](../../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: + +![Recommendations follow button](../../img/recommendations/recommendations_follow_button.jpg) + +Podemos comprobar que tenemos recomendaciones: + +![Recommendations with follows](../../img/recommendations/recommendations_with_follows.jpg) + +La funcionalidad es similar en el menú de debates. diff --git a/docs/img/recommendations/recommendations_follow_button.jpg b/docs/img/recommendations/recommendations_follow_button.jpg new file mode 100644 index 000000000..38bf4a957 Binary files /dev/null and b/docs/img/recommendations/recommendations_follow_button.jpg differ diff --git a/docs/img/recommendations/recommendations_no_follows.jpg b/docs/img/recommendations/recommendations_no_follows.jpg new file mode 100644 index 000000000..ae8b1803d Binary files /dev/null and b/docs/img/recommendations/recommendations_no_follows.jpg differ diff --git a/docs/img/recommendations/recommendations_not_logged_in.jpg b/docs/img/recommendations/recommendations_not_logged_in.jpg new file mode 100644 index 000000000..969180f3c Binary files /dev/null and b/docs/img/recommendations/recommendations_not_logged_in.jpg differ diff --git a/docs/img/recommendations/recommendations_with_follows.jpg b/docs/img/recommendations/recommendations_with_follows.jpg new file mode 100644 index 000000000..83d344899 Binary files /dev/null and b/docs/img/recommendations/recommendations_with_follows.jpg differ