Recensione annuale di Discourse

[Discourse]

	Summary	Discourse Yearly Review creates a topic on January 1st that summarizes the previous year’s forum activity. (See our examples here on Meta - year-in-review)
	Repository Link	https://github.com/discourse/discourse-yearly-review
	Install Guide	How to install plugins in Discourse

As this is an official plugin maintained by the Discourse team, Support, Bug, UX, and Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Initial Setup

Head to your /admin/plugins page to click the discourse-yearly-review Settings button:

1. Enter categories to pull data from into the yearly review categories setting. If left blank, it will default to the top 5 public categories.

2. Using the yearly review publish category setting, choose a destination category for the review to be posted.

   It is highly recommended to set the yearly review publish category to the staff or other private category so that you can view the topic before making it public. You might also like to edit it first.

3. Then, enable the plugin using the yearly review enabled setting.

Features

As you can see at 2022: The Year in Review, data is displayed in two sections - users and topics.

The users section includes:

• Most Time Reading
• Most Topics Created
• Most Replies Created
• Most Replied to
• Most Likes Given
• Most Likes Received
• Most Visits
• Users who have been granted a featured badge (the badge is set by the yearly review featured badge Site Setting

The topics section includes:

• Most Read
• Most Liked
• Most Replied to
• Most Popular
• Most Bookmarked

Generating the Yearly Review

The plugin sets thresholds for deciding which topics to display. There need to be a minimum of 10 likes or replies, 5 bookmarks, a score of 10, or one hour’s read time before a topic will be displayed. The topic is published automatically through a background job. The job checks that the plugin is enabled and that it is within the first 31 days of the first month of the year. It then checks to see if a topic with the title yearly_review.topic_title has already been published by the system user. If all checks pass, the topic is published to the category set in the yearly review publish category setting. If this is not configured, the topic will be published to the Uncategorized category.

Extra Options

Yearly review categories

Categories used in this section are those set in the yearly review categories Site Setting. If this setting is not configured, the 5 best public categories from the forum will be chosen. “Best” is determined by the category topics_year count.

Sub-categories of any categories specified in the yearly review categories Site Setting will not be included in the yearly review report. If you want sub-categories to be included in the yearly review report, you will need to explicitly specify them in the yearly review categories Site Setting.

Yearly review exclude staff

The plugin has a yearly review exclude staff setting. It is enabled by default so that staff members are excluded from the users section and topics created by staff are excluded from the topics section.

Yearly review featured badge

A featured badge can be set via the yearly review featured badge setting. A maximum of 15 badge users are displayed. If more than 15 users have been granted this badge, a link to the badge’s page is displayed. If the yearly review featured badge is not configured, this section will not be displayed.

Running the Yearly Review manually

If you don’t want to wait for the background job, you can publish the topic from the rails console with:

Jobs::YearlyReview.new.execute(force: true)

If you want to generate a report for a specific year just add review_year: 'year', e.g.:

Jobs::YearlyReview.new.execute(force: true, review_year: '2021')

Hosted by us? If you would like to run the Yearly Review manually you can contact us at team@discourse.org and we’ll be happy to arrange that for you.

Settings

Name	Description
yearly review enabled	Enable the yearly review.
yearly review categories	Public categories to pull topics from. The top 5 categories from this group will be selected. If left blank will default to the top 5 public categories.
yearly review exclude staff	Exclude Staff from user stats.
yearly review include user stats	Add user-identifying stats to the first post of the review topic.
yearly review include private categories	Include user activity from private or read-restricted categories in the review.
yearly review publish category	The category the review will be published in.
yearly review featured badge	Enter the full badge name. Can be left blank.

Hosted by us? This plugin is available on all of our hosting tiers Yearly Review | Discourse - Civilized Discussion

---

Known Issues

• The data is displayed in HTML tables. Tables are wrapped in div tags that have data-review-topic-users="true' and data-review-featured-topics="true" attributes. This allows the tables to be styled when they are displayed on Discourse. The styles are not copied when emails for the topics are created. Emails sent out for the topic don’t look great.

• The first post in the generated topic is ≈ 40,000 characters due to using HTML. As a result, it cannot be edited unless you first increase the body character limit above this (see Body is limited to 32000 characters; you entered 43659)

• emojis in titles are not rendered in the featured topic links

Last edited by @nathank 2025-01-06T21:23:15Z

Check document

Perform check on document:

[Samantha_O]

Alcuni bei miglioramenti che potrebbero essere apportati a questo plugin, spero di condividerlo nel posto giusto? Fatemi sapere se non è così.

• Possibilità di escludere lo staff dall’elenco degli utenti, ma includere comunque gli argomenti che creano
• Possibilità di escludere TL4 dall’elenco degli utenti (e come sopra, includere comunque gli argomenti che creano)
• Possibilità di creare più post di revisione in modo da poterne avere uno per i membri TL4 (lo usiamo per i dipendenti) e per i membri dello staff, e poi avere un post solo per i membri della community

[Ayelen_Rives (Aye Rives)]

Ciao!
Ho installato il plugin quest’anno, ma anche se è abilitato, non so quando viene pubblicata la recensione, o se devo fare qualcos’altro per pubblicarla.

Qualcuno può farmelo sapere?
Grazie mille!!

[Aaron_Walsh]

Saluti @Ayelen_Rives,

Ispezionando la console amministrativa, ti verrà presentato il seguente ausilio visivo:

Ulteriori esami all’interno del plugin intitolato ‘plugin:discourse-yearly-review’ rivelano un altro esempio illustrativo:

È imperativo che durante la configurazione delle impostazioni, si designi la categoria di pubblicazione della revisione annuale allo staff o a un’altra categoria ristretta. Ciò garantisce una revisione preliminare prima di consentire una visibilità più ampia.

[Ayelen_Rives (Aye Rives)]

Grazie mille, Aaron!

Inaspettatamente, non vedo quei messaggi nella console amministrativa, né nelle impostazioni:

La categoria di pubblicazione è Staff, quindi scoprirò il 1° gennaio se è stata creata.

Grazie ancora e buone feste!

[Roi]

Buon anno!

Il plugin non è stato eseguito qui in due forum. E ora mostra il messaggio per il 1° gennaio 2025. Strano.

L’ho eseguito manualmente nella console rails in un forum ed è tornato in inglese, non in tedesco, la lingua del forum.

Qualcosa non va/non andava qui.

[JammyDodger]

Non è ancora arrivato nemmeno qui su meta. Ho seguito il consiglio e l’ho impostato per pubblicarlo prima su #staff, che penso sia l’unica differenza rispetto all’anno scorso?

Speravo che apparisse magicamente con un po’ di pazienza, ma potrei essere ottimista.

[Roi]

Non ho cambiato nulla nella configurazione, nemmeno il forum per controllarlo prima come membro dello staff e poi spostarlo,

Nel mio secondo forum non c’è ancora nulla. E qui sono le 11:24.

Sembra che qualcosa sia rotto.

È necessaria una bandiera linguistica quando lo si esegue manualmente? Non voglio tradurre tutto anche nel secondo forum.

[JammyDodger]

Sarei tentato di lasciarlo un po’ più a lungo per vedere se c’è un ritardo nel processo in background, ma non sono nemmeno sicuro del perché l’attivazione manuale dovrebbe dare un risultato diverso rispetto all’esecuzione automatica del processo in background?

Potremmo aver bisogno di qualcuno più esperto che intervenga.

[packman (Chris McMahon)]

Non è partito automaticamente, ma l’ho eseguito manualmente e sembra aver funzionato bene, anche se non volevo che fosse in una lingua diversa.

[Jagster (Jakke Lehtonen)]

La mattina di oggi, più o meno, sidekiq mi ha detto che la revisione annuale sarebbe stata programmata tra 50 minuti e, al momento, sarebbero state circa le 11 ora locale. Non ho aspettato, però, ma l’ho fatta manualmente. Nessun problema e anche la lingua era corretta.

Dopo di che sono stato costretto a declassare i miei moderatori e a rifare sidekiq perché erano molto turbati: ho escluso lo staff… Non potevo permettere lo staff perché altrimenti io, come amministratore molto attivo, avrei dominato completamente le liste, quindi ho scelto la strada più veloce.

Beh, questa è un’altra storia, ma potremmo avere un po’ più di libertà per includere o escludere gruppi?

[Roi]

Santo c… Nell’altro forum c’è il thread del 2023… 14:31 ora locale. E in tedesco. Quindi, ancora misterioso…

[JammyDodger]

Alla fine ho attivato il nostro da Sidekiq.

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]

Sui miei siti l’argomento è stato generato senza che dovessi eseguirlo manualmente in sidekiq.

@Samantha_O

• Possibilità di escludere lo staff dall’elenco degli utenti, ma includere comunque gli argomenti che creano
• Possibilità di escludere TL4 dall’elenco degli utenti (e come sopra, includere comunque gli argomenti che creano)
• Possibilità di creare più post di revisione in modo da poterne avere uno per TL4 (lo usiamo per i dipendenti) e per i membri dello staff, e poi avere un post solo per i membri della community

Questi sono ottimi suggerimenti. Grazie! È interessante sentire altri casi d’uso per questo plugin. Lo esamineremo più attentamente presto, basandoci sull’esperienza di quest’anno, per vedere cosa potremmo fare per migliorarlo prima del prossimo anno!

Nel frattempo, per questa volta, puoi modificare il post una volta pubblicato come ritieni opportuno.

Un comportamento interessante che ho notato è che se elimini l’argomento generato, ne creerà uno nuovo il giorno successivo, finché il plugin è abilitato. Quindi potresti giocare con le impostazioni e generare più versioni dell’argomento di revisione annuale, copiare il testo da esse ed quindi pubblicare nuovi argomenti tu stesso come ritieni opportuno. Se hai accesso a /sidekiq, puoi trovare il job lì ed eseguirlo immediatamente.

[Jagster (Jakke Lehtonen)]

@tobiaseigen

se elimini l’argomento generato

E questo è il motivo per cui un consiglio di pubblicare prima la recensione in una categoria più privata, cioè Staff, e poi spostarla in pubblico, in realtà non è un buon consiglio A meno che un amministratore non voglia mantenere due versioni.

Non è un grosso problema, comunque.

[Ayelen_Rives (Aye Rives)]

@Ayelen_Rives

Lo scoprirò il 1° gennaio se è stato creato.

Ciao! Fortunatamente il plugin si è attivato il 1° gennaio senza alcun problema!

Ora ho alcune domande su come funziona perché alcuni report (come “Most Topics” e “Most likes given”) mostrano risultati diversi rispetto alla pagina “Users” per lo stesso periodo.

Ad esempio, per Most topics, la pagina “Users” mostra per prima l’utente “S”:

E la revisione annuale mostra per prima l’utente “C” e non mostra mai l’utente “S” nella tabella:

(Mi dispiace, devo sfocare le immagini per motivi di riservatezza aziendale, ma penso sia più chiaro se le aggiungo. Inoltre, la tabella è rotta, puoi ignorarla )

Qualcuno sa perché questo potrebbe accadere? Altri report mostrano esattamente le stesse informazioni, ma “Most topics” e “Most likes given” mostrano utenti diversi.

Grazie mille per il tuo aiuto!

[tobiaseigen]

@Jagster

E questo è il motivo per cui un consiglio per pubblicare prima la recensione in una categoria più privata, cioè Staff, e poi spostarla al pubblico, non è in realtà un consiglio così buono A meno che un amministratore non voglia mantenere due versioni.

Whoa, non ero a conoscenza del fatto che questo fosse ciò che accade. L’ho appena testato e hai ragione! Questo è un bug. Non dovrebbe creare un secondo argomento di revisione annuale se ne esiste già uno.

Passaggi per la replica:

1. una volta creato l’argomento di revisione annuale, spostalo in una categoria diversa
2. attiva la creazione dell’argomento di revisione annuale tramite /sidekiq
3. viene creato un secondo argomento di revisione annuale.

Se ti imbatti in questo problema, ti suggerisco di disabilitare il plugin. Esamineremo presto questo plugin per correggere i bug e migliorarlo prima del prossimo anno.

[ganncamp (G Ann Campbell)]

@tobiaseigen

Un comportamento interessante che ho notato è che se elimini l’argomento generato, ne creerà uno nuovo il giorno successivo, a condizione che il plugin sia abilitato.

quanto è persistente? Se continuo a eliminarlo, continueremo a fare il balletto a giugno?

E questo significa che non ho bisogno di contattare il supporto per generare retroattivamente il post per il mio sito? Apparirà domani?

[Jagster (Jakke Lehtonen)]

@ganncamp

quanto è persistente?

Davvero. Funziona tramite sidekiq ogni giorno.

[Moin]

@ganncamp

Se continuo a cancellarlo, faremo ancora la danza a giugno?

Spero che finisca a fine gennaio.

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