 |
概要 | 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 を参照）に引き上げない限り、編集することはできません。
-
題名に含まれる絵文字は、注目のトピックリンクではレンダリングされません