Позволяет участникам сообщества предлагать правки к сообщениям, предоставляя рецензентам детальный контроль над тем, какие изменения принять, — без предоставления полных прав на редактирование.
Плагин находится в стадии экспериментальной разработки и в настоящее время подвергается множеству изменений, поэтому пока не предназначен для использования в производственной среде.
GitHub - discourse/discourse-suggested-edits: EXPERIMENTAL suggested edits plugin · GitHub
Установка
Следуйте стандартному руководству по установке плагинов, используя URL-адрес репозитория:
https://github.com/discourse/discourse-suggested-edits.git
Зачем нужны предлагаемые правки?
Многие сообщества хотят, чтобы участники помогали поддерживать актуальность и точность контента, но предоставление прав на редактирование всем не всегда практично. Функция «Предлагаемые правки» закрывает этот пробел: участники могут предлагать улучшения к сообщениям, а доверенные рецензенты решают, что будет применено. Это как внедрение модели вклада в стиле Википедии в ваше сообщество Discourse.
Это особенно полезно для:
- Разделов базы знаний и документации, где важна точность и требуется проверка многими участниками
- Сообществ с новыми участниками, которые делают хорошие вклады, но ещё не заслужили полного доверия на редактирование
- Совместного контента, такого как FAQ, руководства или поддерживаемые сообществом справочники
- Автоматических правок: иногда системы ИИ предлагают исправления опечаток и стилистических недочётов, и вам нужен человек, который утвердит их
Как это работает
Предложение правки
Участники из настроенной группы «Предлагающие» видят кнопку «Предложить правку» на подходящих сообщениях. При нажатии открывается редактор, предварительно заполненный текстом сообщения. Они вносят изменения, при желании добавляют пояснение и отправляют предложение.
Рецензирование предложений
Рецензенты видят значок с количеством на сообщениях, имеющих ожидающие предложения. Нажатие на «Рецензировать» открывает модальное окно, разбивающее предложение на отдельные изменения — каждое отображается как выделенная разница с контекстом.
Рецензенты могут:
- Принять или отклонить каждое изменение независимо — не нужно принимать всё или ничего
- Отредактировать предложенный текст перед применением — скорректировать формулировку, сохранив смысл
- Переключаться между режимами отображения разницы: встроенный и бок о бок
- Перемещаться между несколькими предложениями, если их несколько в ожидании
Применение изменений
Когда рецензент нажимает «Применить принятые», выбранные изменения применяются к сообщению как ревизия, атрибутированная автору предложения, с указанием причины редактирования, кто её утвердил. Автор предложения и любые другие затронутые пользователи получают уведомление.
Обработка устаревания
Если оригинальное сообщение было отредактировано после создания предложения, оно автоматически помечается как устаревшее и не может быть применено. Это предотвращает конфликты и гарантирует, что предложения всегда основаны на актуальном содержании. Авторы предложений уведомляются, чтобы они могли повторно отправить предложение при необходимости.
Настройка
Включите плагин и настройте доступ в разделе Администрирование > Настройки, выполнив поиск по запросу «предлагаемые правки»:
| Настройка | Описание |
|---|---|
suggested_edits_enabled |
Главный переключатель для плагина |
suggested_edits_suggest_groups |
Группы, участники которых могут предлагать правки |
suggested_edits_review_groups |
Группы, участники которых могут рецензировать и применять предложения. Авторы сообщений всегда могут рецензировать предложения на своих собственных сообщениях. |
suggested_edits_included_categories |
Категории, в которых включены предлагаемые правки |
suggested_edits_included_tags |
Теги тем, в которых включены предлагаемые правки |
suggested_edits_max_creates_per_minute |
Лимит частоты создания предложений (по умолчанию: 5) |
suggested_edits_max_revisions_per_minute |
Лимит частоты редактирования предложений (по умолчанию: 10) |
Типичная настройка
- Включите плагин
- Установите группы предлагающих на уровень доверия или группу, которая должна иметь возможность предлагать правки (например,
trust_level_1) - Установите группы рецензентов на ваших модераторов или кураторов (например,
staff) - Выберите категории или теги, где вы хотите включить эту функцию — не обязательно включать её везде
Авторы сообщений всегда могут рецензировать предложения на своих собственных сообщениях, независимо от настройки группы рецензентов.
Область применения и ограничения
- Только первые сообщения — Предлагаемые правки в настоящее время применяются только к первым сообщениям тем (OP), а не к ответам
- Одно ожидающее предложение от одного пользователя на сообщение — Участник должен дождаться разрешения текущего предложения, прежде чем отправлять новое на том же сообщении
- Предложения основаны на тексте — Разница вычисляется на основе исходного содержимого Markdown сообщения
Поиск
Рецензенты могут использовать поисковый фильтр with:suggested-edits для поиска тем с ожидающими предложениями по всему форуму.