| |
|:-|:-|
|
| 概要 | Discourse 年次レビュー は、1 月 1 日に作成され、前年のフォーラム活動を要約するトピックを作成します（メタの例はこちらを参照 - year-in-review）
|
| リポジトリリンク | https://github.com/discourse/discourse-yearly-review
|
| インストールガイド | Discourse でのプラグインのインストール方法
初期設定
/admin/plugins ページに移動し、discourse-yearly-review の 
設定 ボタンをクリックします:
-
yearly review categories設定に、データを取得するカテゴリを入力します。空白のままにすると、デフォルトで上位 5 つの公開カテゴリが選択されます。 -
yearly review publish category設定を使用して、レビューを投稿する宛先カテゴリを選択します。
公開する前にトピックを確認できるように、yearly review publish categoryをスタッフカテゴリまたは他の非公開カテゴリに設定することを強くお勧めします。最初に編集することもできます。 -
次に、
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')
当社のホスティングをご利用ですか？年次レビューを手動で実行したい場合は、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 | バッジのフルネームを入力します。空白のままにすることもできます。 |
既知の問題
-
データは 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 を参照）
-
注目トピックリンク内のタイトルにある絵文字はレンダリングされません