Bilan annuel de Discourse

[Discourse]

	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

Comme il s’agit d’un plugin official maintenu par l’équipe Discourse, les demandes de Support, de bug, d’améliorations d’expérience utilisateur (ux) et de nouvelles fonctionnalités (#feature) peuvent être soumises dans les catégories respectives ici sur Meta, en les étiquetant avec le tag approprié du plugin. Cliquez sur un lien ci-dessous pour en démarrer un.

 Support  Bug  UX  Fonctionnalité

Configuration initiale

Rendez-vous sur votre page /admin/plugins pour cliquer sur le bouton Paramètres de discourse-yearly-review :

1. 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.

2. À 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 category sur 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.

3. 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.

Hébergé par nous ? Ce plugin est disponible sur tous nos niveaux d’hébergement Yearly Review | Discourse - Civilized Discussion

---

Problèmes connus

• Les données sont affichées dans des tableaux HTML. Les tableaux sont enveloppés dans des balises div ayant les attributs data-review-topic-users="true" et data-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.

[Samantha_O]

Quelques améliorations intéressantes qui pourraient être apportées à ce plugin, j’espère que je partage cela au bon endroit ? Faites-moi savoir si ce n’est pas le cas.

• Possibilité d’exclure le personnel de la liste des utilisateurs, tout en incluant les sujets qu’ils créent
• Possibilité d’exclure les TL4 de la liste des utilisateurs (et comme ci-dessus, inclure toujours les sujets qu’ils créent)
• Possibilité de créer plusieurs publications de révision afin que nous puissions en avoir une pour les TL4 (nous l’utilisons pour les employés) et les membres du personnel, puis avoir une publication réservée aux membres de la communauté.

[Ayelen_Rives (Aye Rives)]

Salut !
J’ai installé le plugin cette année, mais même s’il est activé, je ne sais pas quand la critique est publiée, ou si je dois faire autre chose pour la publier.
Quelqu’un peut-il me le faire savoir ?
Merci beaucoup !!

[Aaron_Walsh]

Salutations @Ayelen_Rives,

Après avoir examiné la console d’administration, vous serez présenté avec l’aide visuelle suivante :

Un examen plus approfondi du plugin intitulé ‘plugin:discourse-yearly-review’ révèle un autre exemple illustratif :

Il est impératif que lors de la configuration des paramètres, vous désigniez la catégorie de publication de la revue annuelle soit au personnel, soit à une autre catégorie restreinte. Cela garantit un examen préliminaire avant d’autoriser une visibilité plus large.

[Ayelen_Rives (Aye Rives)]

Merci beaucoup, Aaron !

De manière inattendue, je ne vois pas ces messages dans la console d’administration, ni dans les paramètres :

La catégorie de publication est Staff, donc je découvrirai le 1er janvier si elle est créée.

Merci encore et bonnes fêtes !

[Roi]

Bonne année !

Le plugin n’a pas fonctionné ici dans deux forums. Et maintenant, il affiche le message pour le 1er janvier 2025. Étrange.

Je l’ai exécuté manuellement dans la console Rails dans un forum et il est revenu en anglais, pas en allemand, la langue du forum.

Quelque chose ne va pas/n’allait pas ici.

[JammyDodger]

Il n’est pas encore arrivé ici non plus sur meta. J’ai suivi le conseil et l’ai configuré pour publier d’abord sur #staff, ce qui, je pense, est la seule différence par rapport à l’année dernière ?

J’espérais qu’il apparaîtrait comme par magie avec un peu de patience, mais je suis peut-être optimiste.

[Roi]

Je n’ai rien changé dans la configuration, pas même le forum pour le vérifier d’abord en tant que membre du personnel et ensuite le déplacer,

Dans mon deuxième forum, il n’y a toujours rien. Et il est 11h24 ici.

On dirait que quelque chose est cassé.

Faut-il un indicateur de langue pour l’exécuter manuellement ? Je ne veux pas tout traduire dans le deuxième forum non plus.

[JammyDodger]

Je serais tenté de laisser cela un peu plus longtemps pour voir s’il y a un délai dans le travail d’arrière-plan, mais je ne suis pas non plus sûr pourquoi le déclencher manuellement donnerait un résultat différent de celui du travail d’arrière-plan qui s’exécute tout seul ?

Nous aurons peut-être besoin de quelqu’un de plus compétent pour intervenir.

[packman (Chris McMahon)]

Le mien ne s’est pas exécuté automatiquement, mais je l’ai juste exécuté manuellement et cela semble avoir fonctionné correctement, bien que je ne le voulais pas dans une langue différente.

[Jagster (Jakke Flemming)]

Ce matin, sidekiq m’a indiqué que la revue annuelle serait programmée dans 50 minutes, ce qui correspondrait à environ 11h, heure locale. Je n’ai pas attendu, mais je l’ai fait manuellement. Aucun problème et la langue était correcte aussi.

Après cela, j’ai été contraint de rétrograder mes modérateurs et de refaire sidekiq car ils étaient vraiment contrariés — j’avais exclu le personnel… Je ne pouvais pas autoriser le personnel car alors moi, en tant qu’administrateur très actif, j’aurais totalement dominé les listes, j’ai donc choisi la voie la plus rapide.

Enfin, c’est une autre histoire, mais pourrions-nous avoir un peu plus de liberté pour inclure ou exclure des groupes ?

[Roi]

Sainte m… Sur l’autre forum, le fil de discussion de 2023 est là… 14h31 heure locale. Et en allemand. Donc, toujours mystérieux…

[JammyDodger]

Je l’ai déclenché depuis Sidekiq finalement.

2023: The Year in Review

2023's Top Users Most Time Reading User Hours Read [avatar] @Canapin 294 [avatar] @Don 233 [avatar] @Moin 186 [avatar] @merefield 158 [avatar] @pfaffman 139 [avatar] @simon 127 [avatar] @Arkshine 118 [avatar] @Jagster 117 [avatar] @ClawdiaWolf 82 [avatar] @Heliosurge 69 Most Topics User Topics [avatar] @twofoursixeight 84 [avatar] @jordan-violet 69 [avatar] @Don 67 [avatar] @danielabc 65 [avatar] @Jagster 62 [avatar] @jidanni 62 [avatar] @Cana…

[tobiaseigen]

Sur mes sites, le sujet a été généré sans que j’aie à l’exécuter manuellement dans sidekiq.

@Samantha_O

• Possibilité d’exclure le personnel de la liste des utilisateurs, tout en incluant les sujets qu’ils créent
• Possibilité d’exclure les TL4 de la liste des utilisateurs (et comme ci-dessus, inclure toujours les sujets qu’ils créent)
• Possibilité de créer plusieurs messages de révision afin que nous puissions en avoir un pour les TL4 (nous l’utilisons pour les employés) et les membres du personnel, puis un message réservé aux membres de la communauté

Ce sont d’excellentes suggestions. Merci ! Il est intéressant d’entendre parler de plus de cas d’utilisation pour ce plugin. Nous allons examiner cela de plus près bientôt, en nous basant sur l’expérience de cette année, pour voir ce que nous pourrions faire pour l’améliorer avant l’année prochaine !

En attendant, pour cette fois, vous pouvez modifier le message une fois qu’il est publié, comme bon vous semble.

Un comportement intéressant que j’ai remarqué est que si vous supprimez le sujet généré, il en créera un nouveau le lendemain, tant que le plugin est activé. Vous pourriez donc jouer avec les paramètres et générer plusieurs versions du sujet de révision annuelle, en copier le texte, puis publier vous-même de nouveaux sujets comme bon vous semble. Si vous avez accès à /sidekiq, vous pouvez trouver le travail là-bas et l’exécuter immédiatement.

[Jagster (Jakke Flemming)]

@tobiaseigen

si vous supprimez le sujet généré

Et c’est pourquoi un conseil pour publier d’abord la critique dans une catégorie plus privée, c’est-à-dire le personnel, puis la déplacer vers le public, n’est en fait pas un très bon conseil À moins qu’un administrateur ne veuille conserver deux versions.

Ce n’est pas grave, cependant.

[Ayelen_Rives (Aye Rives)]

@Ayelen_Rives

Je découvrirai le 1er janvier si elle est créée.

Salut ! Heureusement, le plugin s’est déclenché le 1er janvier sans aucun problème !

Je viens maintenant avec quelques questions sur son fonctionnement car certains rapports (comme “Most Topics” et “Most likes given”) montrent des résultats différents de la page “Users” pour la même période.

Par exemple, pour Most topics, la page “Users” montre d’abord l’utilisateur “S” :

Et le “Yearly review” montre d’abord l’utilisateur “C” et ne montre jamais l’utilisateur “S” dans le tableau :

(Désolé, je dois flouter les images pour des raisons de confidentialité d’entreprise, mais je pense que c’est plus clair si je les ajoute. De plus, le tableau est cassé, vous pouvez l’ignorer )

Quelqu’un sait pourquoi cela pourrait se produire ? D’autres rapports montrent exactement les mêmes informations, mais “Most topics” et “Most likes given” montrent des utilisateurs différents.

Merci beaucoup pour votre aide !

[tobiaseigen]

@Jagster

Et c’est pourquoi un conseil pour publier la critique d’abord dans une catégorie plus privée, c’est-à-dire le personnel, puis la déplacer vers le public, n’est en fait pas un très bon conseil À moins qu’un administrateur ne veuille conserver deux versions.

Whoa, je n’étais pas au courant que c’était ce qui se passait. Je viens de le tester et vous avez raison ! C’est un bug. Il ne devrait pas créer un deuxième sujet d’examen annuel si un existe déjà.

Étapes de reproduction :

1. une fois que le sujet d’examen annuel est créé, déplacez-le dans une catégorie différente
2. déclencher la création du sujet d’examen annuel via /sidekiq
3. un deuxième sujet d’examen annuel est créé.

Si vous êtes confronté à ce problème, je vous suggère de désactiver le plugin. Nous allons examiner ce plugin bientôt pour corriger les bugs et l’améliorer avant l’année prochaine.

[ganncamp (G Ann Campbell)]

@tobiaseigen

Un comportement intéressant que j’ai remarqué est que si vous supprimez le sujet généré, il en créera un nouveau le lendemain, tant que le plugin est activé.

Quelle est sa persistance ? Si je continue à le supprimer, continuerons-nous la danse en juin ?

Et cela signifie-t-il que je n’ai pas besoin de contacter le support pour générer rétroactivement le message pour mon site ? Il apparaîtra simplement demain ?

[Jagster (Jakke Flemming)]

@ganncamp

quelle est sa persistance ?

Vraiment. Il fonctionne via Sidekiq tous les jours.

[Moin]

@ganncamp

Si je continue à le supprimer, danserons-nous toujours en juin ?

J’espérerais que cela s’arrête fin janvier.

The Yearly Review plugin keeps creating new topics

Thanks for following up on this. Relying on the topic’s title to prevent creating multiple review topics is a really flaky approach (that’s my fault.) Once January ends, the issue won’t come up again until next year. @JammyDodger, maybe you could pass a note to the Discourse team to look into coming up with a better way of preventing multiple topics from being created. That should get done before January 2024. Time sure flies