 |
Résumé | Discourse Yearly Review crée un sujet le 1er janvier résumant l’activité du forum de l’année précédente. (Voir nos exemples ici sur Meta - year-in-review) |
 |
Lien du dépôt | https://github.com/discourse/discourse-yearly-review |
 |
Guide d’installation | Comment installer des plugins dans Discourse |
Configuration initiale
Rendez-vous sur votre page /admin/plugins pour cliquer sur le bouton 
Paramètres de discourse-yearly-review :
-
Entrez les catégories dont vous souhaitez extraire les données dans le paramètre
yearly review categories. Si laissé vide, il utilisera par défaut les 5 catégories publiques principales. -
À l’aide du paramètre
yearly review publish category, choisissez une catégorie de destination pour la publication de l’analyse.
Il est fortement recommandé de définir le paramètre yearly review publish categorysur une catégorie réservée au personnel ou une autre catégorie privée afin de pouvoir consulter le sujet avant de le rendre public. Vous pourriez également souhaiter le modifier en premier. -
Ensuite, activez le plugin en utilisant le paramètre
yearly review enabled.
Fonctionnalités
Comme vous pouvez le voir sur 2022: The Year in Review, les données sont affichées en deux sections : utilisateurs et sujets.
La section utilisateurs comprend :
- Temps de lecture le plus élevé
- Plus de sujets créés
- Plus de réponses créées
- Le plus répondu
- Plus de « J’aime » donnés
- Plus de « J’aime » reçus
- Plus de visites
- Utilisateurs ayant reçu un badge mis en avant (le badge est défini par le paramètre du site
yearly review featured badge)
La section sujets comprend :
- Le plus lu
- Le plus aimé
- Le plus répondu
- Le plus populaire
- Le plus mis en favoris
Génération de l’analyse annuelle
Le plugin définit des seuils pour décider quels sujets afficher. Un sujet doit avoir au moins 10 « J’aime » ou réponses, 5 favoris, un score de 10, ou une heure de temps de lecture avant d’être affiché. Le sujet est publié automatiquement via un tâche en arrière-plan. Cette tâche vérifie que le plugin est activé et que nous sommes dans les 31 premiers jours du premier mois de l’année. Elle vérifie ensuite si un sujet avec le titre yearly_review.topic_title a déjà été publié par l’utilisateur système. Si toutes les vérifications réussissent, le sujet est publié dans la catégorie définie dans le paramètre yearly review publish category. Si cela n’est pas configuré, le sujet sera publié dans la catégorie Non classé.
Options supplémentaires
Catégories de l’analyse annuelle
Les catégories utilisées dans cette section sont celles définies dans le paramètre du site yearly review categories. Si ce paramètre n’est pas configuré, les 5 meilleures catégories publiques du forum seront choisies. « Meilleures » est déterminé par le nombre de topics_year de la catégorie.
Les sous-catégories de toute catégorie spécifiée dans le paramètre du site yearly review categories ne seront pas incluses dans le rapport de l’analyse annuelle. Si vous souhaitez inclure des sous-catégories dans le rapport, vous devez les spécifier explicitement dans le paramètre du site yearly review categories.
Exclure le personnel de l’analyse annuelle
Le plugin dispose d’un paramètre yearly review exclude staff. Il est activé par défaut afin que les membres du personnel soient exclus de la section utilisateurs et que les sujets créés par le personnel soient exclus de la section sujets.
Badge mis en avant de l’analyse annuelle
Un badge mis en avant peut être défini via le paramètre yearly review featured badge. Un maximum de 15 utilisateurs du badge est affiché. Si plus de 15 utilisateurs ont reçu ce badge, un lien vers la page du badge est affiché. Si le paramètre yearly review featured badge n’est pas configuré, cette section ne sera pas affichée.
Exécution manuelle de l’analyse annuelle
Si vous ne souhaitez pas attendre la tâche en arrière-plan, vous pouvez publier le sujet depuis la console Rails avec :
Jobs::YearlyReview.new.execute(force: true)
Si vous souhaitez générer un rapport pour une année spécifique, ajoutez simplement review_year: 'année', par exemple :
Jobs::YearlyReview.new.execute(force: true, review_year: '2021')
Hébergé par nous ? Si vous souhaitez exécuter manuellement l’analyse annuelle, vous pouvez nous contacter à team@discourse.org et nous serons heureux de l’organiser pour vous.
Paramètres
| Nom | Description |
|---|---|
| yearly review enabled | Activer l’analyse annuelle. |
| yearly review categories | Catégories publiques dont extraire les sujets. Les 5 catégories principales de ce groupe seront sélectionnées. Si laissé vide, il utilisera par défaut les 5 catégories publiques principales. |
| yearly review exclude staff | Exclure le personnel des statistiques des utilisateurs. |
| yearly review include user stats | Ajouter des statistiques d’identification des utilisateurs au premier post du sujet de l’analyse. |
| yearly review include private categories | Inclure l’activité des utilisateurs provenant de catégories privées ou restreintes en lecture dans l’analyse. |
| yearly review publish category | La catégorie dans laquelle l’analyse sera publiée. |
| yearly review featured badge | Entrez le nom complet du badge. Peut être laissé vide. |
Problèmes connus
-
Les données sont affichées dans des tableaux HTML. Les tableaux sont enveloppés dans des balises
divayant les attributsdata-review-topic-users="true"etdata-review-featured-topics="true". Cela permet de styliser les tableaux lorsqu’ils sont affichés sur Discourse. Les styles ne sont pas copiés lorsque les e-mails pour les sujets sont créés. Les e-mails envoyés pour le sujet ne sont pas très esthétiques. -
Le premier post du sujet généré contient environ 40 000 caractères en raison de l’utilisation de HTML. Par conséquent, il ne peut pas être édité sauf si vous augmentez d’abord la limite de caractères du corps au-dessus de cette valeur (voir Body is limited to 32000 characters; you entered 43659)
-
Les émojis dans les titres ne sont pas rendus dans les liens des sujets mis en avant.