Documentos de Discourse

:warning: Este plugin está siendo retirado en favor del experimental plugin de Categorías de Docs. Seguiremos dando soporte a Docs hasta que el nuevo plugin deje de considerarse experimental.

:discourse2: Resumen Discourse Docs proporciona la capacidad de encontrar y filtrar temas de la base de conocimientos
:hammer_and_wrench: Enlace al repositorio https://github.com/discourse/discourse-docs
:open_book: Guía de instalación Cómo instalar plugins en Discourse

Características

El plugin Discourse Docs es una herramienta potente 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 de Docs que permite un acceso fácil 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 con estilo de base de conocimientos en un conjunto definido de categorías y/o etiquetas.

Filtra la lista por etiquetas, busca mediante la barra de búsqueda y haz clic en los temas para ver el primer mensaje, todo sin salir del contexto del explorador de conocimientos.

¿Necesitas encontrar un tema de la base de conocimientos desde otra parte de Discourse? Usa el nuevo asistente de búsqueda: in:kb.

Configuración

  1. Habilita el plugin activando la configuración docs enabled.

  2. Añade categorías y etiquetas a las configuraciones docs categories y docs tags.

  3. Encuentra el enlace de Docs en el menú de navegación.

  1. ¡Disfruta de un acceso más fácil al conocimiento!

Configuraciones

Nombre Descripción
docs enabled Habilitar el plugin Docs
docs categories Una lista de identificadores de categoría a incluir en docs
show tags by group Organizar etiquetas usando Grupos de Etiquetas. Crea grupos para categorizar etiquetas relacionadas.
docs tag groups Los Grupos de Etiquetas utilizados para mostrar etiquetas por grupo
docs tags Una lista de etiquetas a incluir en docs
docs add solved filter Añade un filtro para temas resueltos; requiere que Discourse Solved esté instalado y habilitado
docs add to top menu Añade un enlace al menú superior para navegar a la vista de Docs
docs add search menu tip Añade el consejo “in:docs” a los consejos aleatorios del menú de búsqueda

Combinaciones útiles

Cambiar la ruta /docs

Si tienes acceso a tu servidor, puedes cambiar la ruta de tu enlace /docs añadiendo 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 desees 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

:discourse2: ¿Alojado por nosotros? Cambiar la ruta /docs solo está disponible en nuestro plan Empresarial. Contáctanos si deseas obtener más información.

Historial de desarrollo

El plugin Docs fue una continuación del Componente de Tema Knowledge Explorer.


:discourse2: ¿Alojado por nosotros? Este plugin está disponible en todos nuestros planes de alojamiento. https://www.discourse.org/plugins/docs.html

95 Me gusta
Discourse Doc Categories
Using Posts as a Wiki?
Using Discourse as a internal Knowledge Base / Intranet
Is anyone working on a Discourse Wiki?
Documentation Library
Community glossary?
The Docs button on meta.discourse
Memberful opinions?
Subcategories and tag groups layout
[Paid] Parent/Child Tagging System + Docs Plugin Group Tagging
Discourse Category Lockdown
Filtering by multiple tags
Docs page in Discourse
Mirrored topic: same topic in two categories
Discourse Docs + Pavilion Layouts Plugin
FAQs, less thread-y more article-y
Topic List Previews (TLP)
Email list server?
Recommnded plugins for supporting a tech community run by a big enterprise?
Is it possible to display the thumbnails in Docs?
Customize docs plugin text link
Install discourse doc plugin from Git is failed
What is this component?
Advice on a support forum
Knowledge Base
Grow my community
Published topic with a link to itself in the forum?
Topic List Thumbnails don't play well with Docs
How-to use Discourse for managing a collaborative newsletter?
Is it possible to restrict certain “docs” to appear based on the user’s groups?
Pinning a post to the top of the topic
Knowledge Base
Discourse has slowly been solving a fatigue I didn't realize I had
Documentation in a Discussion forum
Discourse docs search error, 500 error
Discourse docs search error, 500 error
Discourse Docs Plugin – Topics Not Updating in Docs Page
Forum not working after update – what’s missing?
Knowledge Base
Making my discourse site look a certain way
Time tracking using Discourse?
Back button behavior on docs
Workspace Views
New documentation plugin in development
Is anyone here using their Discourse instance as their entire website?
Question Answer Plugin
How to make the recommanded topics collection
New homes for official and community documentation
Is it possible to show tags in place of subcategories?
Disable auto-scroll for certain topics?
Implementing KCS
How can I compare arbitrary revisions of a post?
How to create a page like the official Discourse docs?
Option to use "Docs view" when accessing Docs category from anywhere in Discourse
DiscoTOC - automatic table of contents
When a thread is too important to lose
About this Community and the Docs
Ability to Create Private Templates
Tips into building a community aside a variety of already existing tools
Sidebar for Subcategories
Published page not visible?
Nest subcategories under their parent categories in the sidebar
File/Document Repository?
Creating user guides for your community
Allow plugins (like docs) to add top-level links in sidebar (rather than hide them in More...)

Hola comunidad de Discourse,

Recibí el siguiente error al ejecutar la especificación. No cambié ningún archivo. ¿Puedo ignorar este error?

➜  discourse git:(main) ✗ LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec

Randomized with seed 57815
...................................F

Failures:

  1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
     Failure/Error: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
       expected to find css ".topic-excerpt" but there were no matches

     [Screenshot Image]: /xxxx/discourse/discourse/tmp/capybara/failures_r_spec_example_groups_discourse_docs_index_topic_excerpts_when_the_theme_modifier_serialize_topic_excerpts_is_true_shows_the_excerpts_460.png

     ~~~~~~~ JS LOGS ~~~~~~~
     ~~~~~ END JS LOGS ~~~~

     # ./plugins/discourse-docs/spec/system/docs_index_spec.rb:52:in `block (4 levels) in <main>'
     # ./spec/rails_helper.rb:469:in `block (2 levels) in <top (required)>'

Finished in 13.16 seconds (files took 2.79 seconds to load)
36 examples, 1 failure

Failed examples:

rspec ./plugins/discourse-docs/spec/system/docs_index_spec.rb:50 # Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts

Randomized with seed 57815

¿Pudiste resolver esto @Hyan?

Se dividieron 3 publicaciones en un nuevo tema: ¿Cómo puedo obtener una tabla de contenido para mis documentos?

Hola Sam, ¿no tendría sentido desde la perspectiva de SEO que el rel=canonical de los temas apunte al tema original? Por ejemplo, Dark/Light Mode Toggle - theme-component - Docs - Discourse MetaDark/Light Mode Toggle - theme-component - Discourse Meta? Me pregunto si las dos versiones de la página no se canibalizan entre sí en los algoritmos de Google.

1 me gusta

Sí, absolutamente deberíamos hacer algo allí

1 me gusta

Lo siento @JammyDodger, no he tenido la oportunidad de ejecutar las especificaciones estos días. No me enfoco en el trabajo relacionado con Discourse Docs, sino en otras cosas estos días. Pero te avisaré cuando tenga alguna oportunidad.

2 Me gusta

¿Hay alguna forma de cambiar el icono junto a Documentos en el Menú Hamburguesa del enlace/cadena a otra cosa?

Este plugin es excelente para tener todas nuestras categorías de documentos en un solo lugar, eliminando la necesidad de que también se listen en la lista de Categorías (gracias a Discourse Category Hider). Sin embargo, hemos notado un problema:

Dentro del plugin/pantalla de Documentos, no se pueden editar documentos existentes ni crear nuevos, lo que significa que tienes que ir a la categoría original para encontrar el tema/documento para editarlo… lo que implica tener el documento accesible en más de un lugar.

¿Hay alguna forma de habilitar la edición de temas/documentos (si el usuario pertenece al Grupo de Usuarios correcto) dentro del plugin de Documentos?

¿Funciona usar el enlace “ver la discusión sobre este tema” en la parte inferior para navegar a ese tema y editarlo?

1 me gusta

Hola, tengo un problema que es realmente molesto y no sé por qué está sucediendo.

Cuando creo un documento, va al área de documentos y funciona como se supone que debe hacerlo; sin embargo, si el documento se edita de alguna manera, el diseño del tema de la lista de documentos vuelve al diseño predeterminado del tema de Discourse al hacer clic y no muestra el diseño real del documento.

He notado que después de unos minutos, vuelve al diseño del documento del tema y se ve como se supone que debe verse, ¿hay algo que pueda estar causando esto?

Nota: también uso el componente de tema “Miniaturas de temas” y lo configuro en el modo de miniatura de documentos “lista”.

Encontré el problema, aparentemente si uso Topic List Excerpts o el componente temático Topic lists Thumbnails, el href en el que se puede hacer clic es para la página del tema de discourse y no para docs?topic=xxx de los KB, por lo que me redirige a los temas de discourse.

¿Hay alguna forma de mantener la ruta de la URL en los docs para docs @sam o debería contactar a @david?

Hola,

Nuestros usuarios notaron recientemente un pequeño problema de estilo: cuando el navegador tiene menos ancho de ventana gráfica, el contenido de cada publicación de documentación se desbordará, como en la siguiente captura de pantalla:

Me pregunto si sería mejor colapsar automáticamente la barra lateral, si la ventana gráfica es menos que ideal; sin embargo, incluso si colapsara la barra lateral, el contenido aún se desbordaría.

Gracias por el maravilloso complemento. Sin embargo, tengo una pregunta: ¿hay una opción para eliminar el enlace del menú hamburguesa contextual? Lo agregué manualmente en la sección siempre visible (ya que queremos usar esta funcionalidad para mostrar contenido creado por el usuario en formato largo, como artículos, etc.) y ahora termina apareciendo dos veces:

Ambas opciones con fondo más claro llevan a /docs

Creo que puedes ocultarlo con algo de CSS aquí:

.sidebar-section-link-wrapper[data-list-item-name=\"docs\"] {
    display: none;
}
1 me gusta

¡Funcionó perfectamente! ¡Muchas gracias!

¿Hay alguna posibilidad de que tengamos una opción para integrar los comentarios en una página de documentación en lugar de enlazar a la publicación y luego poder comentar?

1 me gusta

Volví a visitar el mismo enlace en un dispositivo con el mismo ancho de ventana gráfica. Si bien todavía había desbordamiento antes de colapsar la barra lateral, descubrí que después de colapsarla, no hay desbordamiento y la visualización es normal y estéticamente agradable.

Me sorprende que el orden de búsqueda predeterminado en Docs no sea “Relevancia”, sino “Fecha de actividad”.

¿Es posible buscar por relevancia?

2 Me gusta

Hoy publiqué algunos temas en la categoría de Documentos, pero esos temas no se muestran en la página de Documentos. Desactivé el complemento de Documentos y volví a activar el tema, pero esos temas aún no se muestran.
¡Gracias!