Этот плагин выводится из эксплуатации в пользу экспериментального плагина 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доступно только в нашем корпоративном плане. Пожалуйста, свяжитесь с нами, если вы хотите узнать больше.
История разработки
Плагин Docs был продолжением темового компонента Knowledge Explorer.