 |
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 |
Configuração Inicial
Acesse sua página /admin/plugins para clicar no botão de configurações do discourse-yearly-review 
Configurações:
-
Insira as categorias das quais deseja extrair dados na configuração
yearly review categories. Se deixado em branco, o padrão serão as 5 categorias públicas principais. -
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 categorypara 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. -
Em seguida, ative o plugin usando a configuração
yearly review enabled.
Funcionalidades
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 Respondidos
- Mais Curtidas Dadas
- Mais Curtidas Recebidas
- Mais Visitas
- Usuários que receberam um destaque de badge (o badge é definido 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 antes que um tópico seja exibido. O tópico é publicado automaticamente por meio de um trabalho em segundo plano. O trabalho 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 bem-sucedidas, o tópico é publicado na categoria definida na configuração yearly review publish category. Se isso não for configurado, o tópico será publicado na categoria Não Categorizada.
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 for 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, será necessário 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 para que membros da equipe sejam excluídos da seção de usuários e tópicos criados por equipe sejam excluídos da seção de tópicos.
Badge de Destaque do Resumo Anual
Um badge de destaque pode ser definido via a configuração yearly review featured badge. Um máximo de 15 usuários do badge é exibido. Se mais de 15 usuários tiverem recebido este badge, um link para a página do badge será exibido. Se o yearly review featured badge não for configurado, esta seção não será exibida.
Executando o Resumo Anual Manualmente
Se você não quiser esperar pelo trabalho em segundo plano, pode publicar o tópico no 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 ficaremos felizes em organizar isso para você.
Configurações
| Nome | Descrição |
|---|---|
| yearly review enabled | Ativar o resumo anual. |
| yearly review categories | Categorias públicas para extrair tópicos. As 5 principais categorias deste grupo serão selecionadas. Se deixado em branco, o padrão serão as 5 categorias públicas principais. |
| 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 do badge. Pode ser deixado em branco. |
Problemas Conhecidos
-
Os dados são exibidos em tabelas HTML. As tabelas são envoltas em tags
divque possuem os atributosdata-review-topic-users="true"edata-review-featured-topics="true". Isso permite que as tabelas sejam estilizadas quando exibidas no Discourse. Os estilos não são copiados quando e-mails para os tópicos são criados. Os e-mails enviados para o tópico não ficam ótimos. -
A primeira postagem no tópico gerado tem aproximadamente 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 em títulos não são renderizados nos links de tópicos em destaque