Oportunidades de contribuição para a documentação

[hugh (Hugh Lashbrooke)]

A documentação do Discourse é o local principal para que administradores, moderadores, usuários e sysadmins encontrem ajuda ao usar o Discourse e gerenciar seus sites.

Embora esta documentação seja robusta e abranja muitos aspectos, há algumas áreas que ainda não estão documentadas. Esta é uma ótima oportunidade para a comunidade se envolver e ajudar a refinar esta parte importante do projeto Discourse.

Gostaríamos de ver mais pessoas se envolvendo na criação de conteúdo de documentação para o Discourse e queremos tornar isso o mais fácil possível para qualquer pessoa. Para isso, abaixo está uma lista de recursos ou casos de uso do Discourse que identificamos como necessitando de nova ou melhor documentação.

Locais da documentação

Qualquer pessoa com nível de confiança 2 ou superior pode criar novos tópicos de documentação em Wiki — este é o local para todo o conteúdo de documentação contribuído pela comunidade. Se um tópico na wiki da comunidade for considerado relevante ou importante, ele pode ser movido para Documentation — o local para toda a documentação oficial do Discourse. Você pode ler a política de documentação para mais detalhes sobre isso.

Insígnias para contribuidores de documentação

Qualquer pessoa que criar um novo tópico na categoria Wiki receberá automaticamente a insígnia bronze Scribe:

Se o tópico for considerado valioso o suficiente para ser movido para a categoria oficial Documentation, alguém da equipe do Discourse fará isso manualmente, creditará o autor original no conteúdo do tópico e atribuirá a eles a insígnia prata Ghostwriter:

Documentação que precisa ser escrita

Embora nosso objetivo final seja ver cada parte do Discourse totalmente documentada, estas são as áreas que identificamos com a necessidade mais urgente (itens riscados indicam tópicos que foram escritos desde a primeira publicação desta mensagem):

• Um tutorial geral de início para administradores
• Redirecionamentos personalizados de tópicos
• Explicação do que diferentes níveis de usuário podem fazer
• Opções de login social
• Avisos de postagem (documentação oficial)
• Mais documentação sobre como os níveis de confiança funcionam
• Como escrever um bom pedido de recurso para o Discourse (tópico na wiki)
• Uma referência de como as funcionalidades de formatação e markdown do Discourse aparecem quando incluídas em e-mails
• Status de usuário (tópico na wiki)
• Explicação do modo escuro, como selecioná-lo e como habilitar a alternância (tópico na wiki)
• Documentação geral cobrindo o gerenciamento de preferências de usuário (tópico na wiki)
• Documentos explicando como as categorias e a hierarquia funcionam no Discourse
• Um guia geral sobre configurações de tópicos
• Um guia geral sobre plugins — o que são, como funcionam e como usá-los
• Páginas iniciais personalizadas
• Alteração de categorias e tópicos padrão
• Usando grades de imagens nas postagens (tópico na wiki)
• Configurações de aprovação de postagens (tópico na wiki)

Alguns desses podem exigir múltiplos tópicos para serem documentados de forma eficaz.

Como escrever documentação

Para garantir que a documentação do Discourse seja o mais eficaz possível, temos um guia de estilo sobre como escrever esse conteúdo. Embora seja útil que todos sigam o guia, se você estiver contribuindo para Wiki, não há problema se não seguir completamente. Quaisquer tópicos que forem movidos para Documentation serão atualizados pela equipe do Discourse para corresponder ao guia de estilo, conforme necessário.

Interessado?

Entre em Wiki e comece a documentar hoje. Se quiser discutir qualquer um desses pontos, sinta-se à vontade para responder a este tópico para conversar sobre isso.

[Moin]

E quanto aos tópicos existentes? Como por exemplo

@hugh

Como conceder privilégios de administrador ou moderador a usuários

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

Como escrever uma boa solicitação de recursos para o 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

Como escrever uma boa solicitação de recurso para o Discourse

Solicitando novos recursos para o Discourse

A documentação existente fala sobre como solicitar novos recursos, mas não sobre como formatar uma boa solicitação para torná-la mais eficaz. Atualmente, linkamos para esta página, mas seria bom se pudéssemos ter esse tipo de conteúdo no Meta em vez disso.

@Moin

@hugh

Como conceder privilégios de administrador ou moderador a usuários

Conceder privilégios de administrador ou moderador a um usuário

Boa observação! Vou remover isso da lista neste tópico

[ondrej]

@hugh

Como escrever uma boa solicitação de recurso para o Discourse

Já existe este tópico cobrindo solicitações de recursos

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 precise ter a aparência deste, mas para uma solicitação de recurso?

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 postagem

Isso significa Aviso da Equipe ou algo diferente?

[ondrej]

Assumo que este é um aviso de postagem, já que está no 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…

Avisos da equipe são basicamente os mesmos, imagino?

[hugh (Hugh Lashbrooke)]

@ondrej

A menos que precise parecer assim, mas para um pedido de recurso?

Sim, é isso que estamos procurando lá

@HamMan2118

@hugh

Post notices

Isso significa Aviso de Postagem ou algo diferente?

Como @ondrej linkou, avisos de postagem são o que está descrito neste anúncio. Temos esse tópico de anúncio, mas não a documentação real sobre ele.

[Heliosurge (Dan DeMontmorency)]

Olá Hugh, esta é uma ótima ideia.

Eu estava pensando em apresentar uma ideia para a wiki da comunidade ter algum tipo de tag para, digamos, modelos de fórum.

A ideia que tenho para isso. Frequentemente temos pessoas perguntando sobre o uso do Discourse para coisas como um Fórum de Suporte, Plataforma de Aprendizagem, etc. Até mesmo usos mais obscuros como um RPG de Mesa.

Coletando conteúdo de tópicos como esses e até pensando em vários usos. Poderíamos criar um novo recurso com um Tópico mestre usado como índice.

• Modelos de Fórum de Suporte
• Modelos de Plataforma de Aprendizagem

Esses Tópicos podem abrigar hospedados pelo Discourse, Communique (talvez?) etc., com plugins e componentes de tema recomendados, etc. Bem como uma postagem para auto-hospedado.

Modelos hospedados focariam nos plugins e referenciariam quais planos são necessários para um determinado plugin para uso.

Com dicas e truques e até mesmo direcionando as pessoas para o Marketplace se precisarem de um layout personalizado, plugin, etc.

[NateDhaliwal]

@hugh

Status do usuário

Feito:

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)]

Eu vi isso Ótimo ver que eles estão chegando!

[NateDhaliwal]

Trabalhando na versão para modo escuro.

[NateDhaliwal]

Estes guias já foram feitos, mas ainda não foram marcados como concluídos:

@hugh

Status do usuário

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

Usando grades de imagem em posts

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 iniciais personalizadas

Este é um pouco vago. Refere-se a conteúdo personalizado da página inicial? Se sim, talvez Add custom content that only appears on your homepage. Caso contrário… ainda não foi escrito.

[hugh (Hugh Lashbrooke)]

Obrigado por retornar aqui - atualizei o OP com estes links.

@NateDhaliwal

Este está um pouco borrado. Refere-se a conteúdo personalizado da página inicial?

Esta é uma coisa bastante específica e refere-se à criação de uma página inicial personalizada, portanto, não é algo que a maioria dos administradores do Discourse usará. Não é um recurso principal, pois não está totalmente polido neste estágio.