Categorias de Documentos do Discourse

[pacharanero (Marcus Baw)]

Acho que a confusão e a dificuldade podem ser que o Tópico do Índice precise estar em um certo formato, e isso não está completamente claramente declarado na documentação (post principal)

Eu mesmo instalei este plugin, seguindo cuidadosamente as instruções, mas ele não estava funcionando exatamente da mesma maneira que @dennisjbr estava experimentando.

Pode ajudar ter um exemplo do Markdown necessário em vez de vincular ao exemplo do Meta, porque a única regra chave é que DEVE HAVER uma lista com marcadores/numerada em Markdown. A documentação diz ‘uma lista’, mas a palavra ‘lista’ tem um uso comum em inglês que inclui listas não-Markdown!

Isso funcionará como um Tópico do Índice:

* https://meta.discourse.org/t/discourse-doc-categories/322376
* Algum Texto Arbitrário: https://meta.discourse.org/t/discourse-doc-categories/322376

Isso não funcionará:

https://meta.discourse.org/t/discourse-doc-categories/322376
Algum Texto Arbitrário: https://meta.discourse.org/t/discourse-doc-categories/322376

Além disso, você pode usar cabeçalhos Markdown para criar seções e usar várias listas, mas nada aparecerá na barra lateral, a menos que haja uma lista Markdown. Agradeço que isso seja um pouco óbvio e pode não ter pego mais ninguém, mas me pegou (estupidamente ou não) e eu não sou novo no Discourse, TCs e Plugins.

[hugh (Hugh Lashbrooke)]

Adicionei um exemplo mais explícito de um tópico de índice formatado à postagem original aqui: https://meta.discourse.org/t/discourse-doc-categories/322376#p-1584993-formatting-index-topics-4

Dê uma olhada nisso e me diga se você ainda não consegue resolver.

[pacharanero (Marcus Baw)]

Parece bom para mim @hugh!

[MarcP]

Tenho uma persona de IA para minha categoria de documentação. Houve alguma ideia sobre disponibilizar uma persona de IA para anônimos? Acho que, pelo menos, em um chat DM temporário e anônimo? Isso é possível?

[MarcP]

Ao visitar uma página muito abaixo no índice (requer rolagem para alcançar), a página principal também é rolada para uma posição em algum lugar no meio: por exemplo, neste item de documentação

[hugh (Hugh Lashbrooke)]

Obrigado por destacar isso! Veremos o que podemos fazer para evitar que isso aconteça no futuro.

[Heliosurge (Dan DeMontmorency)]

@pacharanero

Cabeçalhos Markdown para criar seções e usar várias listas, mas nada aparecerá na barra lateral, a menos que haja uma lista Markdown. Agradeço que isso seja um pouco óbvio e pode não ter pego mais ninguém, mas me pegou (estupidamente ou não) e eu não sou novo em Discourse, TCs e Plugins.

Na verdade, nunca se deve considerar algo “óbvio” ao documentar qualquer coisa. Esse tipo de feedback é vital em qualquer tipo de projeto para garantir a clareza.

Qualquer coisa escrita normalmente fará sentido para o autor devido ao seu profundo entendimento do que escreveu. Para os outros, por outro lado, pode ser menos claro.

Eu mesmo não gosto de termos como “intuitivo”, pois algo só é intuitivo se tiver experiências usando algo semelhante.

[dennisjbr]

Obrigado! Isso ajuda muito.

[James_Harakaly]

Trabalho incrível de todos neste plugin!!

NOOB aqui, então peço desculpas antecipadamente! Tenho tentado descobrir isso sozinho por um tempo, mas não consigo encontrar uma solução em lugar nenhum.

Estou tentando usar este plugin como uma forma de organizar os projetos individuais dos usuários no nível da categoria.

Estamos tentando criar um fórum que terá muitos projetos diferentes de usuários. Originalmente, tínhamos todos sob a categoria “projetos”, então, quando alguém clicasse em projetos, veria todas as caixas de subcategorias listando todos os projetos individuais em uma interface bonita (sudo marketplace de projetos).
Mas, ao fazer isso, perdemos esse nível de organização de dados porque os projetos individuais começam como subcategorias em vez de categorias.

Fiquei muito animado quando encontrei este plugin porque pensei que seria perfeito para organizar todos os projetos no nível da categoria, permitindo-nos ter uma melhor organização de dados dentro dos projetos.

Então, agora estou criando projetos individuais como categorias individuais (isca de pesca, projeto 2, projeto 3) e usando o plugin de categorias de documentos para basicamente criar um índice de todos os projetos para que as pessoas possam clicar na nova categoria de projetos que está sendo executada pelo plugin de categorias de documentos e usar o menu suspenso para navegar pelas subcategorias e tópicos que escolhemos listar no tópico do índice.

Existe uma maneira de ter as categorias exibidas na coluna do meio para que se pareça com a visualização da página “todas as categorias” no feed normal do Discourse?

Quero que, quando eu clicar na categoria de documentos de projetos, ela liste todos os projetos à esquerda no menu, mas também os exiba nas caixas no feed principal, assim como acontece normalmente com as subcategorias. Só me foi permitido colocar uma imagem nesta postagem, então coloquei a imagem dos projetos no menu à esquerda e gostaria de ter as caixas de categoria aparecendo no meio, onde minha postagem de tópico está aparecendo.

Obrigado antecipadamente por qualquer ajuda e orientação.

[qianping_chen (rouin)]

Você pode adicionar “links relativos”, como “/t/tópico/463”, que seriam muito eficazes para alterar “nomes de domínio” sem muito trabalho.

[MarcP]

@qianping_chen

o que seria muito eficaz para mudar “nomes de domínio” sem muito trabalho.

Não é muito trabalho atualmente. Basta fazer uma pesquisa e substituição - com que frequência você está trocando de domínio?

[hugh (Hugh Lashbrooke)]

@James_Harakaly

Eu quero que, quando eu clicar na categoria de documentos de projetos, ela liste todos os projetos à esquerda no menu, mas também os exiba nas caixas no feed principal, assim como acontece normalmente com as subcategorias.

Isso parece o que fizemos aqui no Meta para as subcategorias de documentação.

Você pode ver as subcategorias na visualização principal e elas também estão vinculadas na barra lateral aqui: Documentation - Discourse Meta

Para fazer isso funcionar, adicionamos um tópico de índice para a categoria pai de documentação que inclui os links para cada subcategoria: Documentation Index.

Isso ajuda você a encontrar uma boa solução na sua instância?

[Heliosurge (Dan DeMontmorency)]

@MarcP

@qianping_chen

o que seria muito eficaz para mudar “nomes de domínio” sem muito trabalho.

Não é muito trabalho atualmente. Basta fazer uma pesquisa e substituição - com que frequência você está trocando de domínio?

Como a vinculação relativa já funciona. Por que não adicioná-la e eliminar qualquer trabalho desnecessário? Estes são links internos, afinal, e isso contribuiria para a paridade do Discourse, pois os links internos também funcionam com uma variedade de TC e plugins.

[James_Harakaly]

Obrigado, Hugh!

O que vocês estão fazendo com as subcategorias está no caminho certo, mas eu queria principalmente que a interface mostrasse as Categorias nas caixas na coluna do meio, como faz com as subcategorias.

Acabei encontrando e instalando o plugin sub-sub-cat. Então, agora estou usando esse plugin para me ajudar a agrupar subcategorias, para que elas realmente atuem como ‘categorias’, pois temos dois níveis de distribuição de dados abaixo delas: sub-sub-categorias e tópicos.
Isso atendeu ao meu objetivo principal de aumentar a quantidade de distribuição de dados e os níveis de organização dentro dos nossos projetos de usuário. Então, agora estou usando as sub-sub-categorias junto com o plugin para obter o melhor dos dois mundos no nível da categoria stub.
Eu estava tentando criar a categoria do projeto apenas com o plugin de categorias duck, mas não gostamos da interface de ter apenas um menu à esquerda e nada no meio para o usuário navegar. Então, eu queria que os (projetos que são categorias) fossem exibidos dentro de uma Categoria (todos os projetos), como as subcategorias podem fazer normalmente. (minha imagem na última postagem do meu mockup)

aqui está a categoria principal de projetos: BETA - terá outras subcategorias

e aqui estão as ‘sub-sub-categorias’ trabalhando, transformando a subcategoria em uma categoria.
junto com a fácil navegação do tópico do índice.

Obrigado novamente por todo o trabalho que vocês estão fazendo.
Espero ter sido um pouco mais claro nesta postagem.

Encontrei uma solução com a qual estamos muito satisfeitos e é uma combinação dos 2 plugins.

[hugh (Hugh Lashbrooke)]

Fico feliz que você tenha encontrado uma solução que funcione para você!

[hellekin]

Qual é a vantagem deste plugin em relação ao plugin de documentação legado?

No plugin legado, posso ter documentação em qualquer categoria, desde que eu mantenha as tags. Agora parece que todos os tópicos de documentação devem residir em uma única categoria. Isso está correto? Neste caso, está perdendo o contexto, pois alguma documentação (existente) pode ser afetada a grupos/categorias específicos (por exemplo, disponível apenas para a Equipe).

Você poderia esclarecer as diferenças entre as duas abordagens, por que você escolheu esta abordagem e como você pretende fechar a lacuna entre o plugin legado e o novo?

Comentário OT sobre "callouts"

@MarcP

Diferentes tipos de callouts

O HedgeDoc usa a seguinte extensão Markdown para suportar callouts (eles chamam de áreas de alerta):

### Área de Alerta

:::success
Sim :tada:
:::

:::info
Esta é uma mensagem :mega:
:::

:::warning
Cuidado :zap:
:::

:::danger
Oh Não! :fire:
:::

irá exibir

(isso seria muito fácil de estilizar com CSS, dada uma classe).

Comentário OT sobre preguiça e IA

@Jagster

Sou preguiçoso, então não fiz isso manualmente, mas usei a IA do fórum.

Você consegue imaginar o excesso de energia e água consumidos para apenas três linhas de Markdown que você poderia ter copiado e colado manualmente?

Comentário OT sobre URLs relativas vs. absolutas

@qianping_chen

Você pode adicionar “links relativos”, como “/t/tópico/463”, o que seria muito eficaz para mudar “nomes de domínio” sem muito trabalho.

Na verdade, copiar e colar URLs de tópicos é mais fácil, e se você mudar de domínio, provavelmente exportaria/importaria tópicos, e o Discourse substituiria o domínio para você.

---

Após experimentar um pouco, aqui estão minhas conclusões (temporárias):

1. Usar o tópico de descrição da categoria para fornecer um índice de documentação é útil (por exemplo, Singular Docs - Documentation - petites singularités)
2. Uma categoria de Documentação de nível superior permite o uso de subcategorias para alterar o índice da barra lateral de documentação (por exemplo, “Instalar Ruby” aparece em “Guias de Como Fazer” em Documentation - petites singularités, mas em “Dicas e Truques” em Sysadmin Docs - petites singularités) para fornecer uma boa estrutura (veja Documentation aqui, exibindo subcategorias como caixas)
3. Tópicos de documentação podem estar em qualquer lugar do fórum, inclusive em espaços privados – embora o índice de documentação revele sua existência
4. A barra lateral está atualmente instável:
   • às vezes exibe URLs, às vezes o título
   • às vezes apenas texto prefixado
   • quando desconectado, pode faltar alguns tópicos indexados
5. Ao migrar do plugin de documentação legado, o link de documentação deve ser recriado na seção personalizada da barra lateral (mas poderia ser gerado automaticamente alterando /docs para a categoria de documentação na configuração do plugin, ou criando/alterando o permalink /docs para vincular a essa categoria)
6. O link “Voltar ao fórum” parece estranho, porque os tópicos de documentação continuam sendo tópicos do fórum: ainda estamos lá lendo a documentação!
7. A filtragem ainda não leva em conta os nomes de (sub)categorias onde o tópico de documentação pertence.

[MarcP]

Última atualização introduz um pequeno bug de UI quando há uma barra de rolagem.

Também acho que esta caixa de pesquisa “filtro” seria muito mais eficaz se fosse apenas uma consulta de pesquisa personalizada na categoria atual por padrão (em vez de perguntar isso se não houver resultado). Os títulos são muito curtos, então, na maioria dos casos, não haverá correspondência para algo que um usuário não familiarizado digitaria lá.

@hellekin

• O link “Voltar ao fórum” parece estranho, porque os tópicos de documentação continuam sendo tópicos de fórum: ainda estamos lá lendo a documentação!

Mas você está perdendo a barra lateral regular do “fórum”, então voltar ao fórum faz sentido aqui.

[kakaroto (Youness Alaoui)]

Demorou um tempo para descobrir que a barra lateral não estava aparecendo porque, por algum motivo, a configuração do menu de navegação estava definida como “dropdown do cabeçalho” em vez de “Barra lateral”. Para aqueles que também não conseguiram fazer a barra lateral aparecer, esse pode ser o motivo.

Agora estou preso tentando descobrir como adicionar o cabeçalho da categoria e as caixas de subcategoria como vemos aqui:

Não consigo ver nenhuma configuração para ativar/desativar isso e, infelizmente, parece que não quer aparecer.
Se alguém tiver alguma ideia, agradeceria a visão.
Obrigado.

[Moin]

Category Banners

Summary Category Banners uses existing category details to create banners for your category pages (for tags check out Discourse Tag Banners). Preview Preview on Discourse Theme Creator Repository Link https://github.com/discourse/discourse-category-banners New to Discourse Themes? Beginner’s guide to using Discourse Themes Install this theme component Features Category Banners uses existing category details to cr…

Display boxes for subcategories above topic list

This guide explains how to display boxes for subcategories above the topic list in Discourse. Required user level: Administrator (or moderator if the moderators manage categories and groups setting is enabled) There are two ways to display a list of sub-categories within the parent category: in boxes with only the name, logo, and description in boxes with name, logo, and a list of some featured topics You can enable these styles by visiting the parent cate…

[omarfilip]

A falta de filtragem por tag diminui muito a utilidade do plugin. Em uma comunidade onde um documento pode se aplicar a várias categorias, a filtragem por tag é essencial.

Por exemplo, um documento chamado Montagem do Trem de Pouso se aplica a vários modelos de aeronaves e também pode conter várias tags. Encontrar o correto é muito fácil com a filtragem por tag.

Se você tiver que escolher uma categoria para o documento, o que você faz quando esse mesmo documento também deveria estar em várias outras categorias?

As tags eram o índice automático que agora precisa ser criado e mantido manualmente.