This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
Summary
Discourse Docs provides the ability to find and filter knowledge base topics
The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. It’s a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.
Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.
For the change to take effect you can either ./launcher rebuild app or, as it’s an environment variable, you can ./launcher destroy app && ./launcher start app to minimise downtime. There’s a little more info on that here - Set Environmental Variables
You may also want to change the site display text as well to match. You can search for all instances of ‘docs’ from your /admin/customize/site_texts page, but the main ones would be:
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
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.
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?
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?
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:
¿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?
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.
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!
This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
