Oportunidades de contribución a la documentación

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.

:notebook_with_decorative_cover: 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.

:gift: 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:

:eyes: 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.

:pencil2: 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.

:bulb: ¿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.

12 Me gusta

¿Qué pasa con los temas existentes? Por ejemplo

4 Me gusta

La documentación existente habla sobre cómo solicitar nuevas funciones, pero no sobre cómo formatear una buena solicitud para hacerla más efectiva. Actualmente enlazamos a esta página, pero sería bueno si pudiéramos tener ese tipo de contenido en Meta en su lugar.

Y para esto:

¡Buena observación! Lo eliminaré de la lista en este tema :slight_smile:

3 Me gusta

Ya existe este tema que cubre las solicitudes de funciones

¿A menos que deba verse así pero para una solicitud de funciones? :point_down: :eyes:

4 Me gusta

¿Significa esto Aviso del personal o algo diferente?

1 me gusta

Supongo que este es un aviso de publicación, ya que está en el título

Los avisos del personal son básicamente lo mismo, ¿supongo?

3 Me gusta

Sí, eso es lo que estamos buscando allí :slight_smile:

Como @ondrej enlazó, los avisos de publicación son los descritos en este anuncio. Tenemos ese tema de anuncio, pero no documentación real al respecto.

4 Me gusta

Hola Hugh, esta es una gran idea.

He estado pensando en presentar una idea para la wiki de la comunidad para tener algún tipo de etiqueta para, digamos, plantillas de foros.

La idea que tengo para esto. A menudo tenemos gente preguntando sobre el uso de Discourse para cosas como un Foro de Soporte, una Plataforma de Aprendizaje, etc. Incluso a veces usos más oscuros como un RPG de Mesa.

Recopilando contenido de temas como esos e incluso pensando en varios usos. Podríamos crear un nuevo recurso con un Tema maestro utilizado como índice.

  • Plantillas de Foro de Soporte
  • Plantillas de Plataforma de Aprendizaje

Estos Temas pueden alojar Discourse, Communique (¿entonces?) etc., con plugins recomendados y componentes de temas, etc. Así como una publicación para Autoalojado.

Las plantillas alojadas se centrarían en los plugins y harían referencia a los planes necesarios para usar un plugin en particular.

Con consejos y trucos e incluso dirigiendo a la gente al Marketplace si necesitan un diseño, plugin, etc. personalizado.

3 Me gusta

Hecho:

7 Me gusta

¡Lo vi :smile:! ¡Genial ver que llegan!

8 Me gusta

Trabajando en el modo oscuro.

5 Me gusta

Estas guías ya se han creado pero aún no se han marcado:

Esta es un poco confusa. ¿Se refiere al contenido personalizado de la página de inicio? Si es así, quizás Add custom content that only appears on your homepage. De lo contrario… aún no se ha escrito.

2 Me gusta

Gracias por volver a contactar aquí; he actualizado la publicación original con estos enlaces.

[cita=“NateDhaliwal, post:22, topic:326614”]
¿Este es un poco borroso? ¿Se refiere al contenido personalizado de la página principal?

[/cita]

Esto es algo bastante específico y se refiere a crear una página de inicio personalizada, por lo que no es algo que la mayoría de los administradores de Discourse usarán. No es una característica principal, ya que aún no está completamente pulida en esta etapa.

2 Me gusta