Этот плагин выводится из эксплуатации в пользу экспериментального плагина Doc Categories. Мы продолжим поддерживать Docs, пока новый плагин не перестанет считаться экспериментальным.
 |
Краткое описание | Discourse Docs предоставляет возможность находить и фильтровать темы базы знаний |
 |
Ссылка на репозиторий | https://github.com/discourse/discourse-docs |
 |
Руководство по установке | Как установить плагины в Discourse |
Возможности
Плагин Discourse Docs — это мощный инструмент, который превращает ваш форум Discourse в базу знаний, управляемую сообществом. Он предоставляет выделенный раздел Docs, где пользователи могут создавать, обновлять и курировать документацию. Плагин включает кнопку Docs для удобного доступа к этому разделу. Это отличный способ использовать коллективные знания вашего сообщества и предоставить централизованный ресурс для важной информации.
По сути, Docs позволяет упростить поиск тем в стиле базы знаний по заданному набору категорий и/или тегов.
Фильтруйте список по тегам, выполняйте поиск через строку поиска и нажимайте на темы, чтобы увидеть первый пост — всё это без выхода из контекста исследователя знаний.
Нужно найти тему базы знаний из другого места в Discourse? Используйте новый помощник поиска: in:kb.
Настройка
-
Включите плагин, активировав параметр
docs enabled. -
Добавьте категории и теги в параметры
docs categoriesиdocs tags. -
Найдите ссылку Docs в меню навигации.
- Получите выгоду от более удобного доступа к знаниям!
Параметры
| Название | Описание |
|---|---|
| docs enabled | Включить плагин Docs |
| docs categories | Список слайгов категорий, которые будут включены в docs |
| show tags by group | Организовать теги с помощью групп тегов. Создайте группы для категоризации связанных тегов. |
| docs tag groups | Группы тегов, используемые для отображения тегов по группам |
| docs tags | Список тегов, которые будут включены в docs |
| docs add solved filter | Добавляет фильтр для решённых тем — требуется установка и включение плагина Discourse Solved |
| docs add to top menu | Добавляет ссылку в верхнее меню для перехода к представлению Docs |
| docs add search menu tip | Добавляет подсказку “in:docs” в случайные подсказки меню поиска |
Полезные сочетания
Переименование пути /docs
Если у вас есть доступ к серверу, вы можете изменить путь ссылки /docs, добавив переменную окружения DISCOURSE_DOCS_PATH: в файл app.yml:
Чтобы изменения вступили в силу, вы можете выполнить ./launcher rebuild app или, поскольку это переменная окружения, ./launcher destroy app && ./launcher start app, чтобы минимизировать время простоя. Подробнее об этом можно узнать здесь — Set Environmental Variables
Также, возможно, вы захотите изменить отображаемый текст на сайте, чтобы он соответствовал новому пути. Вы можете найти все вхождения слова ‘docs’ на странице /admin/customize/site_texts, но основными из них являются:
- js.docs.title
- js.sidebar.docs_link_text
Размещено у нас? Переименование пути
/docsдоступно только в нашем плане Enterprise. Свяжитесь с нами, если хотите узнать больше.
История разработки
Плагин Docs является продолжением компонента темы Knowledge Explorer.