Customizing FAQs and Guidelines

:bookmark: Это руководство для администраторов по настройке страниц часто задаваемых вопросов (FAQ) и правил на сайте Discourse.>
:person_raising_hand: Требуемый уровень доступа пользователя: Администратор

Настройка страниц FAQ и правил в Discourse позволяет адаптировать контент под специфические потребности и правила вашего сообщества. Эти страницы часто становятся первой точкой отсчета для новых пользователей, помогая им понять, чего от них ожидают, а также служат ресурсом для существующих участников.

Страницы FAQ и правил

По умолчанию в Discourse включена только страница FAQ.

Однако вы также можете создать страницу правил. Это позволяет разместить более специализированный контент на каждой странице: FAQ отвечает на распространенные вопросы, а страница правил описывает нормы сообщества.

Чтобы добавить страницу правил на ваш сайт, необходимо добавить URL темы или внешний URL в настройку администратора faq url. Здесь также можно использовать URL опубликованной страницы.

Это создаст страницу правил (доступную по адресу .../guidelines) вместе с существующей вкладкой FAQ.

Переименование FAQ в Правила (Предстоящее изменение)

Discourse внедряет предстоящее изменение (rename_faq_to_guidelines), которое переименовывает страницу FAQ в «Правила» в навигации. Когда это изменение включено:

  • Вкладка навигации показывает Правила вместо FAQ
  • Адреса /faq, /rules и /conduct перенаправляют на /guidelines (если faq_url не установлен)
  • Ссылка в боковой панели меняется с «FAQ» на «Правила»
  • Если faq_url установлен, обе вкладки «Правила» и «FAQ» по-прежнему отображаются (как и раньше)

Содержимое страницы FAQ остается неизменным — меняются только метка и маршрутизация. Вы можете управлять этим предстоящим изменением на странице Администрирование → Предстоящие изменения.

Контент FAQ и правил

Страница FAQ в Discourse поставляется с контентом по умолчанию, который служит шаблоном для правил форума и часто задаваемых вопросов. Чтобы отредактировать этот контент:

  1. Перейдите к теме FAQ/Правила на вашем форуме, которая обычно создается по умолчанию при настройке экземпляра Discourse. Эта тема обычно закреплена в категории персонала, но может находиться в других категориях, если была перемещена.
  2. Отредактируйте пост так же, как и любой другой пост на форуме. Как администратор или модератор, вы можете изменить текст, чтобы он соответствовал правилам и ожиданиям вашего сообщества.
  3. После внесения необходимых изменений сохраните правки, чтобы обновить содержимое страницы FAQ.

Если вы хотите ссылаться на внешний FAQ, вы можете изменить настройку сайта faq_url, указав URL вашей внешней страницы часто задаваемых вопросов.

Если вы добавили страницу правил, она будет использовать тему FAQ/Правила для своего контента, и вы можете настроить содержимое страницы правил, следуя аналогичному процессу, описанному выше.

Имена меток навигации

Вы можете настроить текстовые метки, используемые в меню навигации для FAQ и правил, на странице Администрирование → Настройка → Текст (.../admin/customize/site_texts/).

Ищите js.guidelines и js.faq, чтобы найти текстовое содержимое, соответствующее меткам навигации, и измените их на предпочитаемые вами термины.

Вы также можете обновить метку навигации, используемую в боковой панели для FAQ, отредактировав js.sidebar.sections.community.links.faq.content. Если включено предстоящее изменение rename_faq_to_guidelines, вместо этого отредактируйте js.sidebar.sections.community.links.guidelines.content.

Дополнительные детали об этом процессе можно найти по адресу Customize text in Discourse.

Маршруты URL

Если сайт не включает страницу правил, вы можете получить доступ к странице FAQ по следующим URL-ссылкам:

  • /faq
  • /guidelines
  • /rules
  • /conduct

Если сайт включает страницу правил, для доступа к ней можно использовать следующие URL:

  • /guidelines
  • /rules
  • /conduct

При наличии страницы правил доступ к странице FAQ возможен только по адресу /faq или через SiteSetting.faq_url.

:bulb: Когда включено предстоящее изменение rename_faq_to_guidelines и faq_url не установлен, адреса /faq, /rules и /conduct перенаправляют на /guidelines.

:person_raising_hand: Есть ли способ изменить маршруты URL, такие как /faq и /guidelines?

Нет. В ядре Discourse нет функций для изменения этих маршрутов, хотя это возможно с помощью плагина.

Скрытие меток навигации

В зависимости от того, как вы хотите структурировать свой сайт, вам может потребоваться скрыть ссылки навигации для страниц FAQ и правил. Это можно сделать, внеся изменения CSS на вашем сайте.

В частности, вы можете скрыть метки навигации FAQ и правил с помощью следующего CSS:

Скрыть метку навигации FAQ

.nav-pills .nav-item-faq {
    display: none;
}

Скрыть метку навигации Правил

.nav-pills .nav-item-guidelines {
    display: none;
}

Кроме того, вы можете скрыть кнопку FAQ из боковой панели / гамбургер-меню, используя:

li[data-list-item-name="faq"]{
    display: none;
}

Если включено предстоящее изменение rename_faq_to_guidelines, имя элемента боковой панели меняется на «guidelines», поэтому используйте:

li[data-list-item-name="guidelines"]{
    display: none;
}

Добавление Правил в боковую панель

Вы можете использовать компонент темы Пользовательские ссылки в гамбургер-меню, чтобы добавить ссылку на страницу правил в ваше гамбургер-меню или боковую панель. Подробную информацию об установке этого компонента см. в разделе Установка темы или компонента темы.

После установки компонента темы вы можете использовать следующую запись для добавления ссылки на страницу правил:

Правила,/guidelines,g

Советы по управлению сообществом

Настройка ваших FAQ и правил в Discourse важна для формирования уникальной идентичности и культуры вашего сообщества, а также для определения ожиданий вашего пространства. Это не только помогает создать чувство общности, но и проясняет, что можно и чего нельзя делать, что может значительно снизить нагрузку на модерацию и улучшить пользовательский опыт.

Хорошо структурированный раздел FAQ бесценен для эффективного онбординга новых участников, так как он позволяет заранее ответить на распространенные вопросы, что способствует более глубоким и увлекательным обсуждениям.

Полезно составлять эти документы в позитивном тоне, выделяя поощряемое поведение с четкими примерами. Краткое и хорошо организованное содержание с использованием маркированных списков и заголовков также поможет сделать информацию более понятной.}

9 лайков