Oportunidades para contribuir con la documentación

[hugh (Hugh Lashbrooke)]

La documentación de Discourse es el lugar principal donde los administradores, moderadores, usuarios y sysadmins pueden encontrar ayuda para usar Discourse y gestionar sus sitios.

Aunque esta documentación es robusta y abarca muchos aspectos, hay algunas áreas que aún no están documentadas. Esta es una gran oportunidad para que la comunidad se involucre y ayude a refinar esta parte importante del proyecto Discourse.

Nos encantaría ver a más personas involucradas en la creación de contenido de documentación para Discourse, y queremos hacer que sea lo más fácil posible para cualquiera hacerlo. Para ello, a continuación se presenta una lista de características o casos de uso de Discourse que hemos identificado como necesitados de nueva o mejorada documentación.

Ubicaciones de la documentación

Cualquier persona con un nivel de confianza 2 o superior puede crear nuevos temas de documentación en Wiki; este es el hogar de todo el contenido de documentación contribuido por la comunidad. Si un tema en la wiki de la comunidad se considera relevante o importante, puede ser movido a Documentation, el hogar de toda la documentación oficial de Discourse. Puedes leer la política de documentación para más detalles al respecto.

Insignias para colaboradores de la documentación

Cualquier persona que cree un nuevo tema en la categoría Wiki recibirá automáticamente la insignia de bronce Scribe:

Si el tema se considera lo suficientemente valioso como para ser movido a la categoría oficial Documentation, alguien del equipo de Discourse lo hará manualmente, acreditará al autor original en el contenido del tema y le asignará la insignia de plata Ghostwriter:

Documentación que necesita ser escrita

Aunque en última instancia queremos ver cada parte de Discourse documentada exhaustivamente, estas son las áreas que hemos identificado con la necesidad más urgente (los elementos tachados indican temas que han sido escritos desde que este primer post fue publicado):

• Un tutorial general de inicio 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
• Avisos de publicación (documentación oficial)
• Más documentación sobre cómo funcionan los niveles de confianza
• Cómo escribir una buena solicitud de función para Discourse (tema wiki)
• Una referencia de cómo se ven las características de markdown y formato 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 preferencias de usuario (tema wiki)
• Documentos que explican cómo funcionan las categorías y la jerarquía en Discourse
• Una guía general sobre la configuración de temas
• Una guía general sobre complementos: 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 múltiples temas para ser documentados efectivamente.

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. Aunque sería útil que todos siguieran la guía, si estás contribuyendo a Wiki, no es un problema si no la sigues completamente. Cualquier tema que se mueva 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 Wiki y comienza a documentar hoy. Si quieres discutir algo de esto, no dudes en responder a este tema para hablar sobre ello.

[Moin]

¿Qué pasa con los temas existentes? Por ejemplo

@hugh

Cómo conceder privilegios de administrador o moderador a los usuarios

Promoting a User to Admin or Moderator Status

This is a how-to guide intended to help existing site admins understand how to promote a user to admin or moderator status through Discourse. Required user level: Administrator Admin privileges in Discourse are powerful and allow the user to manage almost all aspects of the site. For full details on what staff users can do on a site, see Understanding user statuses, roles, and permissions. Here is a step-by-step process on how to promote a user to admin or …

@hugh

Cómo escribir una buena solicitud de funciones para Discourse

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

[hugh (Hugh Lashbrooke)]

@Moin

@hugh

Cómo escribir una buena solicitud de funciones para Discourse

Solicitar nuevas funciones para Discourse

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:

@Moin

@hugh

Cómo otorgar privilegios de administrador o moderador a los usuarios

Otorgar privilegios de administrador o moderador a un usuario

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

[ondrej]

@hugh

Cómo escribir una buena solicitud de funciones para Discourse

Ya existe este tema que cubre las solicitudes de funciones

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

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

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@hugh

Avisos de publicación

¿Significa esto Aviso del personal o algo diferente?

[ondrej]

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

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

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

[hugh (Hugh Lashbrooke)]

@ondrej

¿A menos que deba verse así pero para una solicitud de función?

Sí, eso es lo que estamos buscando allí

@HamMan2118

@hugh

Publicar avisos

¿Esto significa Aviso del personal o algo diferente?

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.

[Heliosurge (Dan DeMontmorency)]

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.

[NateDhaliwal]

@hugh

Estados de usuario

Hecho:

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

[hugh (Hugh Lashbrooke)]

¡Lo vi ! ¡Genial ver que llegan!

[NateDhaliwal]

Trabajando en el modo oscuro.

[NateDhaliwal]

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

@hugh

Estados de usuario

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

@hugh

Uso de cuadrículas de imágenes en las publicaciones

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

Páginas de inicio personalizadas

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.

[hugh (Hugh Lashbrooke)]

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.