Como podemos estruturar melhor o #howto?

Temos um monte de guias. Às vezes, @dax ou @jomaxro compartilham um guia howto que eu nem sabia que existia, e fico impressionado!

Também notei que isso é comum para muitos usuários novos e gestores de comunidade do Discourse aqui no Meta. Então, pensando em resolver isso, @justin teve uma ideia incrível: agrupar nossos guias howto e oferecer a todos um ponto de partida melhor, com a esperança de chegar a algo semelhante a https://support.teams.discourse.com/docs

No momento, estou considerando três categorias:

  • Primeiros Passos
  • Contribuição (incluindo nossos tutoriais e guias de plugins e temas)
  • Configuração

Para você, quais guias howto se encaixam em cada categoria?

Adoraria ouvir suas ideias :smiley::heart:

13 curtidas

Acho que você não receberá nenhuma resposta aqui, pois não há motivação para as pessoas assumirem esse trabalho.

Ou precisamos atribuir isso à nossa equipe ou precisamos encontrar uma maneira de simplificar (talvez usando tags?).

6 curtidas

São tantos :sweat_smile:

11 curtidas

Parece que eu estava errado! Obrigado. :slight_smile:

7 curtidas

Haha, sim, são! Idealmente, se pudéssemos ter de 6 a 12 tutoriais por categoria, seria ótimo. Não estamos buscando categorizar todos, apenas os melhores que as pessoas podem estar procurando.

@osioke – uma maneira de abordar isso é procurar os tutoriais mais visualizados que se correlacionam com essas categorias e escolher os 6 a 12 mais visualizados para marcá-los como tal. Seria um ponto de partida fácil, combinado com as sugestões de @Benjamin_D aqui!

A beleza das tags é que podemos editá-las facilmente conforme avançamos.

7 curtidas

Obrigado por compartilhar isso, @Benjamin_D! Uma das coisas com as quais eu estava lutando era como apresentar e como pensar na estrutura; sua tabela aqui ajuda muito.

Agora estou buscando expandir o agrupamento de 3 para 6:

  • Começando
  • Configuração
  • Configuração Avançada
  • Contribuindo
  • Configurando
  • Configuração Avançada

E, como @justin compartilhou, olhando os mais visualizados, tenho os primeiros 20:

O que vocês acham?

Isso acabaria sendo uma grande mudança, então permitam-me chamar os grandes nomes e cc: @trust_level_3

9 curtidas

Hmm, os artigos sobre configuração de login provavelmente poderiam ter uma categoria própria, e são um subconjunto de “Primeiros Passos”, pois são uma das primeiras coisas que você deseja fazer em um novo site, se quiser fazê-las de todo.

7 curtidas

Não tenho certeza se é necessário mencionar o multisite aqui :thinking: ou talvez o grupo de configuração avançada pudesse vir com um aviso, pesquise no meta! Por exemplo, esta postagem é muito útil prós e contras de uma instalação multisite.

Sobre Enviar Convites em Massa para Usuários, atualmente tenho usado links de convite de uso múltiplo, talvez valha a pena mencionar ambos os tópicos?

Acho que eu configuraria Configurar Resposta por Suporte via E-mail :envelope: no grupo de configuração avançada (já que ainda não fiz isso :see_no_evil:) e entrega direta simplificada de e-mails recebidos provavelmente vale a pena mencionar, mas talvez no grupo de configuração avançada, porque… bem… e-mail :scream:.

O grupo contrib parece um pouco vazio; talvez algo relacionado a temas ou componentes seria legal, como guia do desenvolvedor para temas Discourse, guia do designer para temas Discourse e guia para iniciantes sobre como usar o Theme Creator e o Theme CLI para começar a criar um tema Discourse.

3 curtidas

É verdade, a lista é baseada nos 20 mais visualizados, e eu compartilhei isso para mostrar meu raciocínio sobre a organização. De forma alguma é a lista final; eu deveria ter sido um pouco mais claro :sweat_smile:

3 curtidas

Gostaria de ver administração ou operações como uma categoria para atividades contínuas de administração e moderação. Não se encaixa em configuração/configuração e não é desenvolvimento/documentação (contribuindo).

2 curtidas

Suponho que o site de documentação do Discourse for Teams esteja usando o Discourse para todos os documentos. O problema disso para um site de tutoriais sobre o Discourse, onde qualquer pessoa da comunidade pode participar, é a versionamento e o acompanhamento de tudo. Tenho certeza de que usar o Discourse para isso seria o método preferido, mas posso sugerir talvez um site Hugo ou um site Jekyll, com os documentos sendo arquivos em um repositório do GitHub para que qualquer pessoa possa enviar PRs. Se você não gostar de nenhuma dessas opções, existem muitos outros sistemas de documentação em repositórios do GitHub disponíveis em diversas variações.

1 curtida

Ah, o versionamento funciona muito bem no Discourse, até muito bem. E, combinado com a segurança de acesso por categoria, temos algo do qual nos orgulhamos em usar :wink:

Isso parece correto. Você poderia compartilhar algumas postagens que se encaixariam lá?

2 curtidas

A título de informação, tenho trabalhado gradualmente na limpeza de #howto:sysadmin, verificando se cada uma está atualizada e relevante e, em seguida, movendo-as para auto-delete-posts-after. Parece que a maioria delas foi categorizada aqui como configuração avançada.

7 curtidas

Concordo plenamente. Multisite é uma configuração super super avançada e não é algo que damos muito suporte no Meta.

Com certeza. Discourse + o plugin Docs + algumas customizações extras. Usar o Discourse é nossa preferência para isso, mas vejo os benefícios de usar também um site de wiki/SSG.

Muito obrigado por fazer isso :heart:

6 curtidas

Seria ótimo se os tópicos “menos apoiados” pudessem ir para sua própria categoria claramente marcada.

Parece haver uma mentalidade atual de que, se algo está escrito aqui, o suporte é de alguma forma devido.

Isso também facilita defender que os usuários testem antes de atualizar, pois esses recursos geralmente são mais frágeis ou menos amplamente testados entre as versões.

Subpasta, multisite, categorias terciárias entrariam todos nessa categoria, certo?

6 curtidas

Acho que o multisite é bastante “suportado”, mas espera-se que, se você seguir por esse caminho, saiba que há mais expectativas sobre você (por exemplo, você precisa pensar no que rebuild app significa em vários contextos). Eu diria que é “avançado”, mas não “super super avançado”.

Concordo que categorias terciárias e subpastas são “super super avançadas”.

4 curtidas

Talvez eu esteja pensando mais em multisite com Let’s Encrypt, que repetidamente apresentou falhas ao longo dos anos e, às vezes, a documentação atualizada demorou semanas ou meses para ser publicada.

4 curtidas

Ahh. Sim. Acredito que isso seja bastante estável agora (acho que a última mudança teve a ver com como os redirecionamentos eram tratados no nginx), e tenho um artigo em Multisite Configuration with Let's Encrypt and no reverse proxy - Documentation - Literate Computing Support que pretendo postar aqui Realmente Muito Em Breve (foi em 2 de dezembro de 2020 que escrevi e testei pela última vez). Mas multisite é definitivamente algo em que você está quase sozinho. Acredito que não faça sentido a menos que você tenha pelo menos 3 (talvez 10?) sites, já que parece que a maioria das pessoas que acha que quer isso está tentando se virar em um único droplet de 1GB.

4 curtidas

O que eu acharia mais útil seria se você não se esforçasse tanto em estruturar a categoria (how-to) em si, mas sim em dar uma melhor estrutura à documentação.

Eu realmente aprecio que o fórum seja fluido para os usuários postarem. Acho que, para isso, é fundamental ter boas categorias de nível superior e que os usuários postem na correta delas. Mas quando as subcategorias ficam complexas, quando se torna importante para os usuários postar na subcategoria certa ou saber em qual subcategoria procurar coisas, eu acho isso um pouco disruptivo.

No momento, você praticamente apenas espelha a configuração do fórum na documentação:

Por que não usar etiquetas exclusivas para a equipe para curar e estruturar a documentação, como ‘docs-getting-started’, ‘docs-setup’ — com conteúdo de qualquer lugar do fórum? Assim, você poderia configurar uma página de Documentação que seja mais do que apenas um espelho do fórum, mas que tenha um sumário devidamente curado, como:

Documentação
+Começando
+Configuração
+Configuração Avançada
+Contribuindo
+Configurando
+Configuração Avançada

2 curtidas

Essa é, na verdade, a ideia aqui, @manuel! Estamos planejando criar algumas formas de filtrar facilmente por esses tipos de tutoriais, mas ainda manter os filtros que já existem no plugin Docs. Organizar esses tutoriais em tags específicas é o primeiro passo.

6 curtidas