Revisão anual do Discourse

[Discourse]

| |
|-|-|
| Resumo | Resumo Anual do Discourse cria um tópico em 1º de janeiro que resume a atividade do fórum do ano anterior. (Veja nossos exemplos aqui no Meta - year-in-review) |
| Link do Repositório | https://github.com/discourse/discourse-yearly-review |
| Guia de Instalação | Como instalar plugins no Discourse |

Como este é um plugin #oficial mantido pela equipe do Discourse, solicitações de #suporte, Contribute > Bug, Contribute > UX e Contribute > Feature podem ser feitas nas respectivas categorias aqui no Meta, marcadas com a tag apropriada do plugin. Clique em um link abaixo para iniciar uma.

 Suporte  Bug  UX  Recurso

Configuração Inicial

Acesse sua página /admin/plugins para clicar no botão Configurações do discourse-yearly-review:

1. Insira as categorias das quais extrair dados na configuração yearly review categories. Se deixado em branco, o padrão serão as 5 principais categorias públicas.

2. Usando a configuração yearly review publish category, escolha uma categoria de destino para onde o resumo será publicado.

   É altamente recomendável definir a yearly review publish category para a categoria de equipe ou outra categoria privada, para que você possa visualizar o tópico antes de torná-lo público. Você também pode querer editá-lo primeiro.

3. Em seguida, ative o plugin usando a configuração yearly review enabled.

Recursos

Como você pode ver em 2022: The Year in Review, os dados são exibidos em duas seções — usuários e tópicos.

A seção de usuários inclui:

• Mais Tempo de Leitura
• Mais Tópicos Criados
• Mais Respostas Criadas
• Mais Respostas Recebidas
• Mais Curtidas Dadas
• Mais Curtidas Recebidas
• Mais Visitas
• Usuários que receberam uma medalha em destaque (a medalha é definida pela Configuração do Site yearly review featured badge)

A seção de tópicos inclui:

• Mais Lidos
• Mais Curtidos
• Mais Respondidos
• Mais Populares
• Mais Marcados

Gerando o Resumo Anual

O plugin define limites para decidir quais tópicos exibir. É necessário um mínimo de 10 curtidas ou respostas, 5 marcadores, uma pontuação de 10 ou uma hora de tempo de leitura para que um tópico seja exibido. O tópico é publicado automaticamente por meio de um job em segundo plano. O job verifica se o plugin está ativado e se está dentro dos primeiros 31 dias do primeiro mês do ano. Em seguida, verifica se um tópico com o título yearly_review.topic_title já foi publicado pelo usuário do sistema. Se todas as verificações forem aprovadas, o tópico é publicado na categoria definida na configuração yearly review publish category. Se isso não estiver configurado, o tópico será publicado na categoria Sem Categoria.

Opções Extras

Categorias do Resumo Anual

As categorias usadas nesta seção são aquelas definidas na Configuração do Site yearly review categories. Se essa configuração não estiver definida, as 5 melhores categorias públicas do fórum serão escolhidas. “Melhores” é determinado pela contagem de topics_year da categoria.

Subcategorias de qualquer categoria especificada na Configuração do Site yearly review categories não serão incluídas no relatório do resumo anual. Se você quiser que subcategorias sejam incluídas no relatório do resumo anual, precisará especificá-las explicitamente na Configuração do Site yearly review categories.

Excluir Equipe do Resumo Anual

O plugin possui uma configuração yearly review exclude staff. Ela está ativada por padrão, de modo que membros da equipe são excluídos da seção de usuários e tópicos criados por membros da equipe são excluídos da seção de tópicos.

Medalha em Destaque do Resumo Anual

Uma medalha em destaque pode ser definida por meio da configuração yearly review featured badge. No máximo, 15 usuários com a medalha são exibidos. Se mais de 15 usuários tiverem recebido essa medalha, um link para a página da medalha será exibido. Se a yearly review featured badge não estiver configurada, esta seção não será exibida.

Executando o Resumo Anual Manualmente

Se você não quiser esperar pelo job em segundo plano, pode publicar o tópico pelo console do rails com:

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

Se quiser gerar um relatório para um ano específico, basta adicionar review_year: 'ano', por exemplo:

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

Hospedado por nós? Se você quiser executar o Resumo Anual manualmente, pode entrar em contato conosco em team@discourse.org e teremos prazer em organizar isso para você.

Configurações

Nome	Descrição
yearly review enabled	Ativar o resumo anual.
yearly review categories	Categorias públicas das quais extrair tópicos. As 5 principais categorias deste grupo serão selecionadas. Se deixado em branco, o padrão serão as 5 principais categorias públicas.
yearly review exclude staff	Excluir a equipe das estatísticas de usuários.
yearly review include user stats	Adicionar estatísticas de identificação de usuários à primeira postagem do tópico de resumo.
yearly review include private categories	Incluir atividade de usuários de categorias privadas ou restritas à leitura no resumo.
yearly review publish category	A categoria em que o resumo será publicado.
yearly review featured badge	Insira o nome completo da medalha. Pode ser deixado em branco.

Hospedado por nós? Este plugin está disponível em todos os nossos planos de hospedagem Yearly Review | Discourse - Civilized Discussion

---

Problemas Conhecidos

• Os dados são exibidos em tabelas HTML. As tabelas são envoltas em tags div que possuem os atributos data-review-topic-users="true" e data-review-featured-topics="true". Isso permite que as tabelas sejam estilizadas quando exibidas no Discourse. Os estilos não são copiados quando os e-mails para os tópicos são criados. Os e-mails enviados para o tópico não ficam bons.

• A primeira postagem no tópico gerado tem ≈ 40.000 caracteres devido ao uso de HTML. Como resultado, ela não pode ser editada a menos que você primeiro aumente o limite de caracteres do corpo acima disso (veja Body is limited to 32000 characters; you entered 43659)

• Emojis nos títulos não são renderizados nos links de tópicos em destaque

[Samantha_O]

Algumas boas melhorias que poderiam ser feitas neste plugin, espero que esteja compartilhando no lugar certo? Me avisem se não estiver.

• Capacidade de excluir funcionários da lista de usuários, mas ainda incluir os tópicos que eles criam
• Capacidade de excluir TL4 da lista de usuários (e como acima, ainda incluir os tópicos que eles criam)
• Capacidade de criar várias postagens de revisão para que possamos ter uma para membros TL4 (usamos isso para funcionários) e membros da equipe, e depois ter uma postagem apenas para membros da comunidade

[Ayelen_Rives (Aye Rives)]

Olá!
Instalei o plugin este ano, mas mesmo ele estando habilitado, não sei quando a avaliação é postada, ou se devo fazer algo mais para publicá-la.

Alguém pode me informar?
Muito obrigado!!

[Aaron_Walsh]

Saudações @Ayelen_Rives,

Ao inspecionar o console administrativo, você será apresentado ao seguinte auxílio visual:

Uma análise mais aprofundada dentro do plugin intitulado ‘plugin:discourse-yearly-review’ revela outro exemplo ilustrativo:

É imperativo que, ao configurar as definições, você designe a categoria de publicação da revisão anual para a equipe ou outra categoria restrita. Isso garante uma revisão preliminar antes de permitir uma visibilidade mais ampla.

[Ayelen_Rives (Aye Rives)]

Muito obrigado, Aaron!

Inesperadamente, não vejo essas mensagens no console administrativo, nem nas configurações:

A categoria de publicação é Staff, então descobrirei em 1º de janeiro se ela foi criada.

Obrigado novamente e boas festas!

[Roi]

Feliz Ano Novo!

O plugin não rodou aqui em dois fóruns. E agora mostra a mensagem para 1º de janeiro de 2025. Estranho.

Eu o executei manualmente no console do Rails em um fórum e ele retornou em inglês, não em alemão, que é o idioma do fórum.

Algo está/estava errado aqui.

[JammyDodger]

Ainda não chegou aqui no meta também. Segui o conselho e defini para publicar primeiro em #staff, que acho que é a única diferença em relação ao ano passado?

Eu esperava que aparecesse magicamente com um pouco de paciência, mas talvez eu esteja otimista.

[Roi]

Não alterei nada na configuração, nem mesmo o fórum para verificá-lo primeiro como membro da equipe e depois movê-lo,

No meu segundo fórum ainda não há nada. E são 11:24 aqui.

Parece que algo está quebrado.

É necessária uma flag de idioma ao executá-lo manualmente? Eu também não quero traduzir tudo no segundo fórum.

[JammyDodger]

Eu estaria tentado a deixar um pouco mais para ver se há um atraso no trabalho em segundo plano, mas também não tenho certeza por que acioná-lo manualmente daria um resultado diferente de ter o trabalho em segundo plano executado por conta própria?

Podemos precisar de alguém mais experiente para opinar.

[packman (Chris McMahon)]

O meu não rodou automaticamente, mas acabei de rodar manualmente e parece ter funcionado bem, embora eu não quisesse que fosse em um idioma diferente.

[Jagster (Jakke Flemming)]

Hoje de manhã, o Sidekiq me informou que a revisão anual seria agendada em 50 minutos, o que seria por volta das 11h no horário local. Eu não esperei, porém, e fiz manualmente. Não houve problemas e a linguagem estava correta também.

Depois disso, fui forçado a rebaixar meus moderadores e fazer o Sidekiq novamente porque eles estavam muito chateados — eu excluía a equipe… Eu não podia permitir a equipe porque, como um administrador muito ativo, eu dominaria totalmente as listas, então escolhi o caminho mais rápido.

Bem, essa é outra história, mas poderíamos ter um pouco mais de liberdade para incluir ou excluir grupos?

[Roi]

Santo… No outro fórum, o tópico de 2023 está lá… 14:31, horário local. E em alemão. Então, ainda é um mistério…

[JammyDodger]

Eu acionei o nosso do Sidekiq no final.

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]

Nos meus sites o tópico foi gerado sem que eu tivesse que executá-lo manualmente no sidekiq.

@Samantha_O

• Capacidade de excluir funcionários da lista de usuários, mas ainda incluir os tópicos que eles criam
• Capacidade de excluir TL4 da lista de usuários (e, como acima, ainda incluir os tópicos que eles criam)
• Capacidade de criar vários posts de revisão para que pudéssemos ter um para membros TL4 (usamos isso para funcionários) e membros da equipe, e então ter um post apenas para membros da comunidade

Estas são ótimas sugestões. Obrigado! É interessante ouvir sobre mais casos de uso para este plugin. Analisaremos isso mais de perto em breve, com base na experiência deste ano, para ver o que podemos fazer para melhorá-lo antes do próximo ano!

Enquanto isso, para esta rodada, você pode editar o post assim que ele for publicado, como achar melhor.

Um comportamento interessante que notei é que, se você excluir o tópico gerado, ele criará um novo no dia seguinte, desde que o plugin esteja ativado. Assim, você pode brincar com as configurações e gerar várias versões do tópico de revisão anual, copiar o texto delas e, em seguida, publicar novos tópicos você mesmo, como achar melhor. Se você tiver acesso a /sidekiq, poderá encontrar o job lá e executá-lo imediatamente.

[Jagster (Jakke Flemming)]

@tobiaseigen

se você excluir o tópico gerado

E é por isso que uma dica para publicar a revisão primeiro em uma categoria mais privada, ou seja, Staff, e depois movê-la para pública, na verdade não é um bom conselho A menos que um administrador queira manter duas versões.

Nada demais, porém.

[Ayelen_Rives (Aye Rives)]

@Ayelen_Rives

Descobrirei em 1º de janeiro se foi criado.

Olá! Felizmente o plugin disparou sozinho em 1º de janeiro sem nenhum problema!

Venho agora com algumas perguntas sobre como funciona, pois alguns relatórios (como Tópicos Mais Criados e Likes Mais Dadas) mostram resultados diferentes da página de Usuários para o mesmo período.

Por exemplo, para Tópicos Mais Criados, a página de Usuários mostra primeiro o usuário “S”:

E a revisão anual mostra primeiro o usuário “C” e nunca mostra o usuário “S” na tabela:

(Desculpe, tive que borrar as imagens por confidencialidade da empresa, mas acho que fica mais claro se eu as adicionar. Além disso, a tabela está quebrada, você pode ignorá-la )

Alguém sabe por que isso pode estar acontecendo? Outros relatórios mostram exatamente as mesmas informações, mas Tópicos Mais Criados e Likes Mais Dadas mostram usuários diferentes.

Muito obrigado pela ajuda!

[tobiaseigen]

@Jagster

E é por isso que uma dica para publicar a avaliação primeiro em uma categoria mais privada, ou seja, Staff, e depois movê-la para pública, na verdade não é um bom conselho A menos que um administrador queira manter duas versões.

Uau, eu não sabia que era isso que acontecia. Acabei de testar e você está certo! Este é um bug. Ele não deveria criar um segundo tópico de avaliação anual se um já existe.

Passos para reprodução:

1. Assim que o tópico de avaliação anual for criado, mova-o para uma categoria diferente
2. Acione a criação do tópico de avaliação anual via /sidekiq
3. Um segundo tópico de avaliação anual é criado.

Se você for afetado por este problema, sugiro desabilitar o plugin. Vamos analisar este plugin em breve para corrigir bugs e melhorá-lo antes do próximo ano.

[ganncamp (G Ann Campbell)]

@tobiaseigen

Um comportamento interessante que notei é que, se você excluir o tópico gerado, ele criará um novo no dia seguinte, desde que o plugin esteja ativado.

Quão persistente é isso? Se eu continuar excluindo, ainda estaremos dançando em junho?

E isso significa que não preciso entrar em contato com o suporte para gerar retroativamente a postagem para o meu site? Ela simplesmente aparecerá amanhã?

[Jagster (Jakke Flemming)]

@ganncamp

quão persistente é?

Realmente. Funciona via sidekiq todos os dias.

[Moin]

@ganncamp

Se eu continuar a excluí-lo, ainda faremos a dança em junho?

Eu esperaria que parasse no final de janeiro.

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