Discourse 年間レビュー

| |
|:-|:-|:expressionless:
|:discourse2: | 概要 | Discourse 年次レビュー は、1 月 1 日に作成され、前年のフォーラム活動を要約するトピックを作成します(メタの例はこちらを参照 - year-in-review
|:hammer_and_wrench: | リポジトリリンク | https://github.com/discourse/discourse-yearly-review
|:open_book: | インストールガイド | Discourse でのプラグインのインストール方法

初期設定

/admin/plugins ページに移動し、discourse-yearly-review の :gear: 設定 ボタンをクリックします:

年次レビューの設定

  1. yearly review categories 設定に、データを取得するカテゴリを入力します。空白のままにすると、デフォルトで上位 5 つの公開カテゴリが選択されます。

  2. yearly review publish category 設定を使用して、レビューを投稿する宛先カテゴリを選択します。

    :bulb: 公開する前にトピックを確認できるように、yearly review publish category をスタッフカテゴリまたは他の非公開カテゴリに設定することを強くお勧めします。最初に編集することもできます。

  3. 次に、yearly review enabled 設定を使用してプラグインを有効にします。

機能

2022: The Year in Review でご覧いただくとおりに、データは「ユーザー」と「トピック」の 2 つのセクションで表示されます。

ユーザーセクションには以下が含まれます:

  • 最も長時間読んだ人
  • 最も多くのトピックを作成した人
  • 最も多くの返信を作成した人
  • 最も多く返信された人
  • 最も多く「いいね」を送った人
  • 最も多く「いいね」を受けた人
  • 最も多くの訪問数
  • 注目のバッジが付与されたユーザー(バッジは yearly review featured badge サイト設定で設定されます)

トピックセクションには以下が含まれます:

  • 最も読まれたもの
  • 最も「いいね」されたもの
  • 最も多く返信されたもの
  • 最も人気のあるもの
  • 最もブックマークされたもの

年次レビューの生成

このプラグインは、表示するトピックを決定するためのしきい値を設定します。トピックが表示されるには、最低 10 件の「いいね」または返信、5 件のブックマーク、スコア 10、または 1 時間の読了時間が必要です。トピックは、バックグラウンドジョブを通じて自動的に公開されます。このジョブは、プラグインが有効であり、かつ年の最初の月の最初の 31 日以内であることを確認します。その後、システムユーザーによって yearly_review.topic_title というタイトルのトピックがすでに公開されているかを確認します。すべてのチェックをパスすると、トピックは yearly review publish category 設定で指定されたカテゴリに公開されます。これが設定されていない場合、トピックは「未分類」カテゴリに公開されます。

追加オプション

年次レビューカテゴリ

このセクションで使用されるカテゴリは、yearly review categories サイト設定で設定されたものです。この設定が構成されていない場合、フォーラムから上位 5 つの公開カテゴリが選択されます。「上位」は、カテゴリの topics_year 数によって決定されます。

yearly review categories サイト設定で指定されたカテゴリのサブカテゴリは、年次レビューレポートに含まれません。サブカテゴリを年次レビューレポートに含めたい場合は、yearly review categories サイト設定で明示的に指定する必要があります。

年次レビューからスタッフを除外

このプラグインには yearly review exclude staff 設定があります。デフォルトで有効になっており、ユーザーセクションからスタッフメンバーが除外され、スタッフによって作成されたトピックがトピックセクションから除外されます。

年次レビューの注目バッジ

yearly review featured badge 設定を通じて、注目バッジを設定できます。最大 15 人のバッジユーザーが表示されます。このバッジが付与されたユーザーが 15 人を超える場合、バッジページへのリンクが表示されます。yearly review featured badge が設定されていない場合、このセクションは表示されません。

年次レビューを手動で実行する

バックグラウンドジョブを待つ必要がない場合は、rails コンソールから以下のコマンドでトピックを公開できます:

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

特定の年のレポートを生成したい場合は、review_year: 'year' を追加してください。例:

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

:discourse2: 当社のホスティングをご利用ですか?年次レビューを手動で実行したい場合は、team@discourse.org までご連絡ください。喜んで手配いたします。

設定

名前 説明
yearly review enabled 年次レビューを有効にする。
yearly review categories トピックを取得する公開カテゴリ。このグループから上位 5 つのカテゴリが選択されます。空白のままにすると、デフォルトで上位 5 つの公開カテゴリが選択されます。
yearly review exclude staff ユーザー統計からスタッフを除外する。
yearly review include user stats レビュートピックの最初の投稿にユーザーを特定する統計を追加する。
yearly review include private categories 非公開または読み取り制限のあるカテゴリからのユーザー活動をレビューに含める。
yearly review publish category レビューが公開されるカテゴリ。
yearly review featured badge バッジのフルネームを入力します。空白のままにすることもできます。

:discourse2: 当社のホスティングをご利用ですか?このプラグインは、すべてのホスティングプランで利用可能です Yearly Review | Discourse - Civilized Discussion


既知の問題

  • データは HTML テーブルで表示されます。テーブルは、data-review-topic-users="true' および data-review-featured-topics="true" 属性を持つ div タグで囲まれています。これにより、Discourse 上に表示された際にテーブルにスタイルを適用できます。ただし、トピック用のメールが作成される際にこれらのスタイルはコピーされません。そのため、トピックに対して送信されるメールの見た目はあまり良くありません。

  • 生成されたトピックの最初の投稿は、HTML の使用により約 40,000 文字になります。その結果、まず本文の文字数制限をこの値以上に増やさない限り編集できません(Body is limited to 32000 characters; you entered 43659 を参照)

  • 注目トピックリンク内のタイトルにある絵文字はレンダリングされません

「いいね!」 90

このプラグインにいくつか良い機能追加ができそうですが、ここで共有して正しい場所でしょうか?もし違っていたら教えてください。

  • スタッフをユーザーリストから除外する機能。ただし、彼らが作成したトピックは含める
  • TL4をユーザーリストから除外する機能(上記と同様に、彼らが作成したトピックは含める)
  • 複数のレビュー投稿を作成する機能。これにより、TL4(従業員に使用)とスタッフメンバー用の投稿、およびコミュニティメンバーのみの投稿を作成できます。
「いいね!」 5

こんにちは!
今年プラグインをインストールしましたが、有効になっているにもかかわらず、レビューがいつ投稿されるのか、または公開するために他に何かする必要があるのかわかりません。

どなたか教えていただけますか?
よろしくお願いします!!

「いいね!」 2

Ayelen_Rives様、こんにちは。

管理コンソールを確認すると、以下の図が表示されます。

さらに、「plugin:discourse-yearly-review」というタイトルのプラグインを詳しく調べると、別の例が示されています。

設定を構成する際には、年次レビューの公開カテゴリをスタッフまたはその他の制限付きカテゴリに指定することが不可欠です。これにより、より広範な公開を許可する前に予備的なレビューが行われます。

「いいね!」 6

アーロン、本当にありがとう!

予期せず、管理コンソールにも設定にもこれらのメッセージが表示されません。

公開カテゴリは「Staff」なので、作成されるかどうかは1月1日に判明します。

改めて感謝し、楽しいホリデーシーズンをお過ごしください!

「いいね!」 2

新年おめでとうございます!:partying_face:

このプラグインは、2つのフォーラムで実行されませんでした。そして今、2025年1月1日のメッセージが表示されます。奇妙です。

一方のフォーラムでレールコンソールで手動で実行したところ、フォーラムの言語であるドイツ語ではなく、英語で返ってきました。

何かが間違っていた/間違っています。

「いいね!」 2

まだメタにも届いていません。アドバイスに従って、まず「#staff」に公開するように設定しましたが、昨年との違いはそれだけだと思いますか

少し待てば魔法のように現れることを期待していましたが、楽観的すぎたのかもしれません。

「いいね!」 2

設定は何も変更していません。スタッフとして確認してから移動するために、フォーラムさえも変更していません。

2番目のフォーラムにも、まだ何もありません。こちらは午前11時24分です。

何かが壊れているようです。

手動で実行する場合、言語フラグは必要ですか?2番目のフォーラムもすべて翻訳したくありません。:wink:

「いいね!」 1

バックグラウンドジョブに遅延がないかもう少し様子を見たい気もしますが、手動でトリガーした場合とバックグラウンドジョブが自動的に実行された場合で、なぜ結果が異なるのかもよくわかりません。

より詳しい人の意見を聞く必要があるかもしれません。

「いいね!」 3

自動では実行されませんでしたが、手動で実行したところ問題なく動作したようです。ただし、別の言語で実行したかったわけではありません。

「いいね!」 1

今朝、サイドキックから年次レビューが50分後にスケジュールされると通知があり、それは私の現地時間で午前11時頃でした。しかし、待てなかったので手動で実行しました。問題はなく、言語も正しかったです。

その後、モデレーターをダウングレードし、再度サイドキックを実行しなければなりませんでした。なぜなら、彼らは本当に不満で、私がスタッフを除外したからです。スタッフを含めると、私のような非常にアクティブな管理者がリストを完全に支配してしまうため、最も早い方法を取りました。

まあ、それは別の話ですが、グループを含めたり除外したりする自由度をもう少し高めることはできませんか?

「いいね!」 2

なんてこった…他のフォーラムでは2023年のスレッドがある…現地時間午後2時31分。ドイツ語で。謎は深まるばかり…

「いいね!」 1

最終的にSidekiqからトリガーしました。:rocket:

「いいね!」 2

私のサイトでは、手動でsidekiqを実行しなくてもトピックが生成されました。

これらは素晴らしい提案です。ありがとうございます!このプラグインのユースケースについてさらに聞くことができて興味深いです。今年の経験に基づいて、来年までに改善できる点がないか、近日中に詳しく検討する予定です!

それまでの間、今回は投稿後に必要に応じて編集できます。

私が気づいた興味深い動作の1つは、生成されたトピックを削除すると、プラグインが有効になっている限り、翌日に新しいトピックが作成されることです。したがって、設定を試して年次レビューのトピックの複数のバージョンを生成し、それらからテキストをコピーして、必要に応じて自分で新しいトピックを公開することができます。 /sidekiqにアクセスできる場合は、そこでジョブを見つけてすぐに実行できます。

「いいね!」 2

だからこそ、レビューをまず非公開カテゴリ(つまりスタッフ)で公開してから、公開に移動するというアドバイスは、実際にはあまり良くないアドバイスです :wink: 管理者が2つのバージョンを維持したい場合を除き。

しかし、大したことではありません。

「いいね!」 1

こんにちは!幸いなことに、プラグインは1月1日に問題なくトリガーされました!:raised_hands:

現在、一部のレポート(「最も多くのトピック」や「最も多くのいいね」など)が、同じ期間の「ユーザー」ページとは異なる結果を示しているため、その仕組みについていくつか質問があります。

例えば、「最も多くのトピック」では、「ユーザー」ページに最初にユーザー「S」が表示されます。

そして、年次レビューでは最初にユーザー「C」が表示され、テーブルにはユーザー「S」がまったく表示されません。

(申し訳ありませんが、会社の機密保持のため画像をぼかす必要がありますが、追加した方が分かりやすいと思います。また、テーブルは壊れているので無視してください :upside_down_face:)

これが起こりうる理由をご存知の方はいらっしゃいますか?他のレポートはまったく同じ情報を示していますが、「最も多くのトピック」と「最も多くのいいね」は異なるユーザーを示しています。

ご協力ありがとうございます!:100:

「いいね!」 1

うわー、これが起こるなんて知らなかった。ちょうどテストしてみたら、君の言う通りだった!これはバグだ。すでに年次レビューのトピックが存在する場合、2つ目の年次レビューのトピックを作成するべきではない。

再現手順:

  1. 年次レビューのトピックが作成されたら、それを別のカテゴリに移動する
  2. /sidekiq を介して年次レビューのトピックの作成をトリガーする
  3. 2つ目の年次レビューのトピックが作成される。

この問題に遭遇した場合は、プラグインを無効にすることをお勧めします。来年までにバグを修正し、プラグインを改善するために、まもなくこのプラグインを調査する予定です。

「いいね!」 1

:thinking: どのくらい永続的なのでしょうか? もし私がそれを削除し続けた場合、6月になってもこのダンスを続けることになりますか? :joy:

そして、これは私がサポートに連絡して、私のサイトのために投稿を遡って生成してもらう必要がないことを意味しますか? 明日、それは単に現れるのでしょうか?

「いいね!」 1

毎日サイドキック経由で動作します。

「いいね!」 1

1月末で終わることを願っています。

「いいね!」 2