コミュニティメンバーが投稿の編集を提案できるようにし、レビュー担当者は完全な編集権限を付与することなく、どの変更を採用するかをきめ細かく制御できます。
このプラグインは実験的なものであり、現時点では多くの変更が加えられる可能性があり、本番環境での使用はまだ想定されていません。
GitHub - discourse/discourse-suggested-edits: EXPERIMENTAL suggested edits plugin · GitHub
インストール
リポジトリURLを使用して、標準のプラグインインストールガイドに従ってください。
https://github.com/discourse/discourse-suggested-edits.git
提案された編集が必要な理由
多くのコミュニティでは、メンバーがコンテンツの正確性と最新性を維持するのに役立つことを望んでいますが、全員に編集アクセス権を付与することが常に現実的であるとは限りません。提案された編集はこのギャップを埋めます。メンバーは投稿の改善を提案でき、信頼できるレビュー担当者が適用される内容を決定します。これは、Wikipediaスタイルの貢献モデルをコミュニティにもたらすものと考えてください。
これは特に次のような場合に役立ちます。
- 正確性が重要であり、多くの人の目があると役立つナレッジベースおよびドキュメントカテゴリ
- 良い貢献をしているものの、まだ完全な編集信頼性を得ていない新しいメンバーがいるコミュニティ
- FAQ、ガイド、またはコミュニティが維持する参照情報などの共同コンテンツ
- AIシステムがタイポや表現の修正を提案する場合があり、人間による承認が必要な自動化された編集
仕組み
編集の提案
設定された提案グループのメンバーは、対象となる投稿に「編集を提案」ボタンが表示されます。これをクリックすると、投稿コンテンツがあらかじめ入力されたコンポーザーが開きます。変更を加え、必要に応じて理由を追加して送信します。
提案のレビュー
レビュー担当者は、保留中の提案がある投稿にカウントバッジが表示されます。 「レビュー」をクリックするとモーダルが開き、提案が個々の変更に分解されます。それぞれの変更が、周囲のコンテキストとともにハイライトされた差分として表示されます。
レビュー担当者は次のことができます。
- 各変更を個別に受け入れるか却下する — すべてを採用するかすべて却下する必要はありません
- 提案されたテキストを適用前に編集する — 意図を保持したまま文言を微調整する
- インラインとサイドバイサイドの差分表示を切り替える
- 複数の提案がある場合は、それらをナビゲートする
変更の適用
レビュー担当者が「承諾されたものを適用」をクリックすると、選択された変更が投稿にリビジョンとして適用され、提案者に帰属します。編集理由は承認者を記録します。提案者およびその他影響を受けるユーザーには通知されます。
古くなった場合の処理
提案が作成された後に元の投稿が編集された場合、その提案は自動的に「期限切れ」としてマークされ、適用できなくなります。これにより競合を防ぎ、提案が常に最新のコンテンツに基づいていることが保証されます。必要に応じて再送信できるように、提案者に通知されます。
設定
プラグインを有効にし、管理者 > 設定で「提案された編集」を検索してアクセスを設定します。\n\n| 設定 | 説明 |\n|----|----|\n| suggested_edits_enabled | プラグインのマスター切り替え |\n| suggested_edits_suggest_groups | 編集を提案できるグループ |\n| suggested_edits_review_groups | 提案をレビューおよび適用できるグループ。投稿作成者は常に自分の投稿の提案をレビューできます。 |\n| suggested_edits_included_categories | 提案された編集が有効なカテゴリ |\n| suggested_edits_included_tags | 提案された編集が有効なトピックのタグ |\n| suggested_edits_max_creates_per_minute | 提案作成のレート制限（デフォルト: 5） |\n| suggested_edits_max_revisions_per_minute | 提案変更のレート制限（デフォルト: 10） |\n\n### 一般的な設定
- プラグインを有効にする
- 提案グループを、編集を提案できる信頼レベルまたはグループに設定します（例:
trust_level_1） - レビューグループをモデレーターやキュレーターなどに設定します（例:
staff） - 有効にしたいカテゴリまたはタグを選択します — すべてで有効にする必要はありません
投稿作成者は、レビューグループの設定に関係なく、常に自分の投稿の提案をレビューできます。
範囲と制限事項
- 最初の投稿のみ — 現在、提案された編集はトピックの最初の投稿（OP）にのみ適用され、返信には適用されません
- ユーザーごとの投稿あたりの保留中の提案は1つのみ — メンバーは、同じ投稿について別の提案を送信する前に、現在の提案が解決されるのを待つ必要があります
- 提案はテキストベース — 差分は投稿の生のMarkdownコンテンツに対して計算されます
検索
レビュー担当者は、検索フィルター with:suggested-edits を使用して、フォーラム全体で保留中の提案があるトピックを見つけることができます。