La documentación de Discourse es el lugar principal para que administradores, moderadores, usuarios y administradores de sistemas encuentren ayuda para usar Discourse y administrar sus sitios.
Si bien esta documentación es sólida y cubre mucho terreno, hay algunas áreas faltantes que aún no hemos documentado. Esta es una gran oportunidad para que la comunidad participe y ayude a refinar esta importante parte del proyecto Discourse.
Nos encantaría ver que más personas participen en la creación de contenido de documentación para Discourse, y queremos que sea lo más fácil posible para que cualquiera lo haga. Para ello, a continuación se presenta una lista de características o casos de uso de Discourse que hemos identificado como que requieren documentación nueva o mejorada.
Ubicaciones de la documentación
Cualquier persona con nivel de confianza 2 o superior puede crear nuevos temas de documentación en Community wiki este es el hogar de todo el contenido de documentación contribuido por la comunidad. Si un tema en el wiki de la comunidad se considera relevante o importante, puede trasladarse a Documentation, el hogar de toda la documentación oficial de Discourse. Puede leer la política de documentación para obtener más detalles al respecto.
Insignias para contribuyentes de documentación
Cualquier persona que cree un nuevo tema en la categoría Community wiki recibirá automáticamente la insignia de bronce Scribe:
Si el tema se considera lo suficientemente valioso como para trasladarlo a la categoría oficial Documentation, alguien del equipo de Discourse lo hará manualmente, dará crédito al autor original en el contenido del tema y le asignará la insignia de plata Ghostwriter:
Documentación que necesita ser escrita
Si bien, en última instancia, queremos ver cada parte de Discourse documentada a fondo, estas son las áreas que hemos identificado con la necesidad más apremiante (los elementos tachados indican temas que se han escrito desde que se publicó esta publicación por primera vez):
- Un tutorial general de introducción para administradores
- Redirecciones de temas personalizadas
- Explicación de lo que pueden hacer los diferentes niveles de usuario
- Opciones de inicio de sesión social
- Publicar avisos (documento oficial)
- Más documentación sobre cómo funcionan los niveles de confianza
- Cómo escribir una buena solicitud de características para Discourse (tema wiki)
- Una referencia de cómo se ven las características de formato y markdown de Discourse cuando se incluyen en correos electrónicos
- Estados de usuario (tema wiki)
- Explicación del modo oscuro, cómo seleccionarlo y cómo habilitar el cambio (tema wiki)
- Documentación general que cubre la gestión de las preferencias del usuario (tema wiki)
- Documentos que explican cómo funcionan las categorías y la jerarquía en Discourse
- Una guía general para la configuración de temas
- Una guía general sobre plugins: qué son, cómo funcionan y cómo usarlos
- Páginas de inicio personalizadas
- Cambio de categorías y temas predeterminados
- Uso de cuadrículas de imágenes en publicaciones (tema wiki)
- Configuración de aprobación de publicaciones (tema wiki)
Algunos de estos pueden requerir varios temas para ser documentados de manera efectiva.
Cómo escribir documentación
Para garantizar que la documentación de Discourse sea lo más efectiva posible, tenemos una guía de estilo sobre cómo escribir este contenido. Si bien sería útil que todos siguieran la guía, si está contribuyendo a Community wiki, no es un problema si no se adhiere completamente a ella. Cualquier tema que se traslade a Documentation será actualizado por el personal de Discourse para que coincida con la guía de estilo según sea necesario.
¿Interesado?
Únete a Community wiki y comienza a documentar hoy mismo. Si deseas discutir algo de esto, no dudes en responder a este tema para hablar sobre ello.

