Este plugin está siendo retirado en favor del plugin experimental Doc Categories. Seguiremos dando soporte a Docs hasta que el nuevo plugin deje de considerarse experimental.
|||
-|-|-|
| Resumen | Discourse Docs proporciona la capacidad de buscar y filtrar temas de la base de conocimientos
| Enlace al repositorio | https://github.com/discourse/discourse-docs
| Guía de instalación | Cómo instalar plugins en Discourse
Características
El plugin Discourse Docs es una herramienta poderosa que transforma tu foro de Discourse en una base de conocimientos impulsada por la comunidad. Proporciona una sección dedicada de Docs donde los usuarios pueden crear, actualizar y curar documentación. Este plugin incluye un botón Docs que permite un fácil acceso a esta sección. Es una excelente manera de aprovechar el conocimiento colectivo de tu comunidad y proporcionar un recurso centralizado para información importante.
En esencia, Docs permite una mayor visibilidad de temas de estilo base de conocimientos a través de un conjunto definido de categorías y/o etiquetas.
Filtra la lista por etiquetas, busca a través de la barra de búsqueda y haz clic en los temas para ver la primera publicación, todo sin salir del contexto del explorador de conocimientos.
¿Necesitas encontrar un tema de la base de conocimientos desde otro lugar en Discourse? Usa el nuevo asistente de búsqueda: in:kb.
Configuración
-
Habilita el plugin activando la configuración
docs enabled. -
Agrega categorías y etiquetas a las configuraciones
docs categoriesydocs tags. -
Encuentra el enlace de Docs en el menú de navegación.
- ¡Aprovecha el acceso más fácil al conocimiento!
Configuraciones
| Nombre | Descripción |
|---|---|
| docs enabled | Habilita el plugin Docs |
| docs categories | Una lista de slugs de categorías para incluir en docs |
| show tags by group | Organiza etiquetas usando Grupos de Etiquetas. Crea grupos para categorizar etiquetas relacionadas. |
| docs tag groups | Los Grupos de Etiquetas usados para mostrar etiquetas por grupo |
| docs tags | Una lista de etiquetas para incluir en docs |
| docs add solved filter | Agrega un filtro para temas resueltos – requiere que Discourse Solved esté instalado y habilitado |
| docs add to top menu | Agrega un enlace al menú superior para navegar a la vista de Docs |
| docs add search menu tip | Agrega el consejo “in:docs” a los consejos aleatorios del menú de búsqueda |
Combinaciones útiles
Renombrar la ruta /docs
Si tienes acceso a tu servidor, puedes cambiar la ruta de tu enlace /docs agregando una variable de entorno DISCOURSE_DOCS_PATH: a tu app.yml:
Para que el cambio surta efecto, puedes ejecutar ./launcher rebuild app o, como es una variable de entorno, puedes ejecutar ./launcher destroy app && ./launcher start app para minimizar el tiempo de inactividad. Hay un poco más de información al respecto aquí: Set Environmental Variables
También es posible que quieras cambiar el texto de visualización del sitio para que coincida. Puedes buscar todas las instancias de ‘docs’ desde tu página /admin/customize/site_texts, pero las principales serían:
- js.docs.title
- js.sidebar.docs_link_text
/docssolo está disponible en nuestro plan Enterprise. Contáctanos si deseas obtener más información.
Historial de desarrollo
El plugin Docs fue una continuación del Componente Temático Knowledge Explorer.