Categorías de Documentos en Discourse

¿Podría usar un enlace externo aquí? ¿Y usar _blank para abrir una nueva pestaña?

Puedes empezar con una breve descripción opcional de la categoría.

## Prueba externa
* Google: https://google.com

## Primera sección
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Título corto: https://discourse.example.com/t/topic-with-a-long-title/56
* Otro título: https://discourse.example.com/t/another-topic-with-a-long-title/78

## Segunda sección
* Título del tema: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
1 me gusta

Las instalaciones no compatibles normalmente recibirán un enlace a las instalaciones no compatibles. Como exención de responsabilidad, ya que cualquier problema podría estar relacionado en parte.

Los plugins, temas y componentes de temas normalmente tendrán un archivo sobre el archivo de compatibilidad de versiones.

Ver abajo

Abrir este archivo proporcionará notas importantes sobre la compatibilidad de versiones. Otros pueden tenerlo dentro de la descripción. Por ejemplo, el plugin Category Moderators mejora y tiene una exención de responsabilidad de solo admitir la rama estable.

Pavilion proporciona la frecuencia de actualización recomendada de discourse para garantizar que tengan tiempo de actualizar sus complementos.

2 Me gusta

¿Funciona esto para subcategorías? Tengo un sitio con 6 categorías principales, pero quiero documentación para cada categoría, así como discusiones. No estoy seguro de la mejor manera de lograr esto.

Sí. Puedes verlo aquí en Documentation. La categoría principal es básicamente una tabla de contenido de las subcategorías.

3 Me gusta

Acabo de encontrar esto y tengo un par de preguntas, por favor: ¿Cómo podemos instalarlo en nuestro sitio alojado en la nube? ¿Y cuánto tiempo más cree que estarán disponibles los antiguos Docs?

1 me gusta

Todavía no tenemos una línea de tiempo para eliminar por completo el antiguo plugin, pero ya no se está desarrollando activamente. Una vez que hayamos tomado algunas decisiones al respecto, publicaremos un anuncio para que todos lo sepan.

Dado que este plugin todavía es experimental, no está disponible en nuestro hosting, pero actualmente estamos discutiendo esto internamente y viendo si podemos hacer que este plugin esté disponible. Volveremos aquí una vez que hayamos llegado a una conclusión.

5 Me gusta

Voy a añadir esto para otros que puedan encontrarlo confuso, como yo, sobre lo que hace realmente el plugin.

Con todos los ajustes, el tema índice, etc., puede resultar abrumador, además de intentar comprender qué se puede hacer, cómo se puede utilizar, etc. Al menos, yo estaba un poco confundido hasta que encontré una manera de entenderlo (si me falta algo, no duden en compartirlo).

Así que, básicamente, la forma en que lo veo es: crea tus categorías como quieras y luego este plugin simplemente elimina la barra lateral predeterminada (con las secciones de categorías, etiquetas, etc.) y la reemplaza con una lista de secciones y enlaces dentro de esas secciones a temas, categorías, enlaces externos, etc. Es simplemente más fácil para mí verlo de esa manera. Se centra más en personalizar la barra lateral cuando se visita una categoría en particular. Algo así como: cuando se visita la categoría A, reemplazar la barra lateral predeterminada con esa barra lateral personalizada proporcionada por el tema índice. Simple.

5 Me gusta

9 publicaciones se dividieron en un nuevo tema: Discourse Docs Plugin – Topics Not Updating in Docs Page

Me pregunto cómo hacer que el índice de la barra lateral en Docs sea más visible en móvil, porque los usuarios no ven los temas hasta que presionan el icono de la hamburguesa.

Es maravilloso en escritorio; desafortunadamente, la mayoría usa sus teléfonos inteligentes.

1 me gusta

No hay demasiadas opciones, o diría que no hay ninguna opción en absoluto. Los móviles simplemente no tienen suficiente espacio.

Esa es una de las razones por las que estoy considerando abandonar por completo los docs. Alrededor del 95% de mis usuarios utilizan móviles, y utilizan la barra lateral muy raramente o nada en absoluto. Por lo tanto, curar el menú de documentación consume bastante tiempo y no creo que la relación tiempo/beneficio esté en equilibrio :smirking_face:

1 me gusta

Creo que mover el ícono de hamburguesa a la izquierda (como en el escritorio) debería mejorar un poco la experiencia del usuario.

La documentación es muy potente, no quiero deshabilitarla, pero nuestros usuarios casi no la usan porque los índices están ocultos (!)

2 Me gusta

Este Theme component podría ser de interés

De acuerdo, he leído toda esta discusión y tengo algunas preguntas. Entiendo que la estructura de esta página se crea a partir de esta página, pero ¿entonces también necesitas una página de índice para cada subcategoría? El índice para esta página, debe ser enorme… o cualquiera de las otras con una gran cantidad de artículos.

¿Qué tan difícil sería implementar un diseño estilo xwiki para las páginas que forman parte de la documentación de un sitio de Discourse? La interfaz de usuario es lo suficientemente simple, marcas la casilla al crear la página indicando que esta página es documentación. Ahora simplemente te pregunta cuál es el padre. ¿Sin padre? Es un tema de nivel superior. Estableces un padre, la página aparece bajo ese tema/categoría. Esto elimina por completo el requisito de mantener manualmente las páginas de índice. Parecen mucho trabajo adicional que no debería ser necesario. Y es fácil pasar por alto agregar cosas a medida que se crean.

Si vas a https://checkin.technospider.com y despliegas algunos de los elementos en la barra lateral, puedes ver cómo funciona la anidación en un ejemplo del mundo real. Toda esa barra lateral se genera dinámicamente simplemente anidando páginas bajo otras páginas (relación padre/hijo). Este sitio solo tiene alrededor de 150 páginas, pero me habría llevado el doble de tiempo completarlo si hubiera tenido que crear índices para todo eso.

Y eso me lleva a un problema de UI/UX con la forma en que está diseñada la barra lateral de Docs. Una vez que haces clic fuera de la página principal, pierdes la lista inicial de categorías. Deberías tener una forma de volver a la página en algún lugar.
Cada una de tus 8 áreas principales debería tener triángulos de divulgación para que, ya sea que hagas clic en la casilla en la página principal o en el nombre en la barra lateral, simplemente se despliegue y no pierdas la capacidad de hacer clic directamente en otra de las áreas principales.
Tienes una ruta de navegación en cada artículo final, pero incluso eso falta en las 8 categorías. Hacer clic en ‘eliminar filtro’ de las subcategorías en la parte superior de la página me devuelve, pero eso es muy poco intuitivo. Y puedes hacer cosas raras jugando con los filtros, por ejemplo, el bonito banner verde desaparece si haces clic en ‘sin subcategorías’.

3 Me gusta

Sí, eso es para temas de gestión del sitio, la página del índice está aquí. (index es una etiqueta que revela todas las páginas del índice)

Estoy de acuerdo en que debió requerir bastante trabajo recopilar todos los enlaces de las páginas y organizarlos bien en categorías con etiquetas. ¡Pero el resultado es tan bueno y útil!

2 Me gusta

[cita=“NiceOldGuy, publicado:113, tema:322376”]
¡Pero el resultado es tan increíblemente bonito y útil!
[/cita]

Definitivamente se ve bien, pero como mencioné, hay algunos problemas de usabilidad en lo que respecta a la navegación.
Y si se puede eliminar ese trabajo, parece una victoria para todos.

No estoy cuestionando el trabajo realizado, se ve muy bien y, ya que no puedo programar para salvar mi vida, ni siquiera puedo empezar a apreciar cuánto trabajo se dedicó, o cuánto más trabajo serían mis sugerencias.

Es bueno para documentación mínima, pero falta mucho de la marca que usé en la wiki a la que enlacé. A menos que simplemente lo esté pasando por alto. Todavía soy bastante nuevo en Discourse.

Por ejemplo, no encuentro una forma de hacer cajas de información/advertencia/error.

Aquí en Meta, se utilizan citas en bloque y emojis.
Quizás este Theme component, que ofrece estilos alternativos, se ajuste a tus necesidades:

3 Me gusta

Gracias, eso parece que será útil una vez que la indexación manual ya no sea necesaria.

7 publicaciones se dividieron en un nuevo tema: Bring back sidebar search in Discourse Doc Categories plugin

Una publicación se fusionó en un tema existente: Add Sidebar support “Discourse Icon” & more

:loudspeaker: Actualizaciones para autoalojados

Para los autoalojados que utilizan este plugin, nuestra actualización más reciente requeriría una reconstrucción manual del índice. Esto implicaría ejecutar esta tarea de rake:

bundle exec rake doc_categories:build_sidebar

# si la ejecución de la tarea anterior falla debido a NoDatabaseError,
# ejecútala con lo siguiente para configuraciones típicas autoalojadas
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar

Si no puedes ejecutar esta tarea de rake, puedes ir a la configuración de cada categoría de documentación, eliminar el índice de la categoría, guardar, volver a añadirla y guardar. Esto las reconstruiría y también actualizaría la caché de la categoría.


¿Por qué estamos haciendo esto?

Anteriormente, cuando la barra lateral tenía que ser poblada, analizábamos cada tema del índice sobre la marcha y los almacenábamos en caché. Esta actualización mueve los índices existentes para que sean respaldados por la base de datos en lugar de un tema. Hacerlo expone a nuestro equipo a más opciones al pensar en formas de mejorar la experiencia del usuario al organizar el índice.

9 Me gusta