Posso usar um link externo aqui? E usar _blank para abrir em uma nova aba?
Você pode começar com uma descrição opcional e breve da categoria.
## Teste externo
* Google: https://google.com
## Primeira seção
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Título curto: https://discourse.example.com/t/topic-with-a-long-title/56
* Outro título: https://discourse.example.com/t/another-topic-with-a-long-title/78
## Segunda seção
* Título do tópico: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Quaisquer instalações não suportadas geralmente receberão um link para instalações não suportadas. Como um aviso, pois quaisquer problemas podem estar relacionados em parte.
Plugins, temas e componentes de temas geralmente terão um arquivo sobre compatibilidade de versão.
Abrir este arquivo fornecerá notas importantes de compatibilidade de versão. Outros podem tê-lo na descrição. Por exemplo, o plugin Category Moderators aprimora o plugin e tem um aviso de que suporta apenas o branch estável.
O Pavilion fornece a frequência de atualização recomendada do Discourse para garantir que eles tenham tempo para atualizar seus add-ons.
Isso funciona para subcategorias? Tenho um site com 6 categorias principais, mas quero documentação para cada categoria, bem como discussão. Não tenho certeza de como conseguir isso da melhor forma.
Acabei de me deparar com isso e tenho algumas perguntas, por favor: Como podemos instalá-lo em nosso site hospedado na nuvem? E quanto tempo mais a documentação antiga ficará disponível, na sua opinião?
Ainda não temos um cronograma para remover completamente o antigo plugin, mas ele não está mais em desenvolvimento ativo. Assim que tomarmos algumas decisões sobre isso, postaremos um anúncio para que todos saibam!
Como este plugin ainda é experimental, ele não está disponível em nossa hospedagem, mas estamos discutindo isso internamente e vendo se podemos disponibilizar este plugin. Voltaremos aqui assim que chegarmos a uma conclusão.
Vou apenas adicionar isto para outros que possam achar confuso, como eu estava, o que o plugin realmente faz.
Com todas as configurações, o tópico de índice, etc., pode parecer avassalador, além de tentar entender o que pode ser feito, como pode ser usado, etc. Pelo menos, eu estava um pouco confuso até descobrir uma maneira de entendê-lo (se estiver perdendo alguma coisa aqui, sinta-se à vontade para compartilhar).
Então, basicamente, a maneira como eu vejo é: crie suas categorias da maneira que desejar e, em seguida, este plugin simplesmente remove a barra lateral padrão (com as seções para categorias, tags, etc.) e a substitui por uma lista de seções e links dentro dessas seções para tópicos, categorias, links externos, etc. É simplesmente mais fácil para mim ver dessa forma. É algo mais focado em personalizar a barra lateral quando uma categoria específica é visitada. Algo como: quando a categoria A é visitada, substitua a barra lateral padrão por essa barra lateral personalizada fornecida pelo tópico de índice. Simples.
Gostaria de saber como tornar o índice lateral no Docs mais visível em dispositivos móveis, porque os usuários não veem os tópicos até pressionar o ícone de hambúrguer.
Está excelente no desktop; infelizmente, a maioria usa seus smartphones.
Não há muitas opções, ou eu diria que não há nenhuma opção. Celulares simplesmente não têm espaço suficiente.
Essa é uma razão pela qual estou considerando abandonar totalmente os docs. Dos meus usuários, cerca de 95% usam celulares, e eles usam a barra lateral raramente ou nunca. Portanto, curar o menu de documentação consome bastante tempo e não acho que a proporção tempo/benefício esteja em equilíbrio
Tudo bem, li toda esta discussão e tenho algumas perguntas. Entendo que a estrutura desta página é criada por esta página, mas então você também precisa de uma página de índice para cada subcategoria? O índice para esta página, deve ser enorme… ou qualquer uma das outras com muitos artigos.
Quão difícil seria implementar um layout estilo xwiki para páginas que fazem parte da documentação de um site Discourse. A UI é simples o suficiente, você marca a caixa na criação da página afirmando que esta página é documentação. Agora, ele simplesmente pergunta qual é o pai. Sem pai? É um assunto de nível superior. Você define um pai, a página aparece sob esse assunto/categoria. Isso elimina completamente a necessidade de manter manualmente páginas de índice. Elas parecem um monte de trabalho extra que não deveria ser necessário. E é fácil esquecer de adicionar coisas à medida que elas são criadas.
Se você for a https://checkin.technospider.com e expandir alguns dos itens na barra lateral, poderá ver como a aninhamento funciona em um exemplo do mundo real. Toda essa barra lateral é gerada dinamicamente simplesmente aninhando páginas sob outras páginas (relação pai/filho). Este site tem apenas cerca de 150 páginas, mas teria levado o dobro do tempo para ser concluído se eu tivesse que criar índices para tudo isso.
E isso me leva a uma questão de UI/UX sobre como a barra lateral de Documentos está organizada. Assim que você clica fora da página principal, você perde a lista inicial de categorias. Você deve ter uma maneira de voltar na página em algum lugar.
Cada uma de suas 8 áreas principais deve ter triângulos de expansão nelas, para que, quer você clique na caixa na página principal ou no nome na barra lateral, ela simplesmente se expanda e você não perca a capacidade de clicar diretamente em outra das áreas principais.
Você tem um breadcrumb em cada artigo final, mas mesmo isso está faltando nas 8 categorias. Clicar em ‘remover filtro’ das subcategorias no topo da página me leva de volta, mas isso é muito pouco intuitivo. E você pode fazer coisas estranhas brincando com os filtros, por exemplo, o belo banner verde desaparece se você clicar em ‘sem subcategorias’.
Sim, isso é para tópicos de gerenciamento de site, a página do índice está aqui. (index é uma tag que revela todas as páginas do índice)
Concordo que deve ter levado um bom trabalho para reunir todos os links das páginas e colocá-los de forma organizada em categorias com rótulos. Mas o resultado é tão bom e utilizável!
Definitivamente parece bom, mas como eu disse, existem alguns problemas de usabilidade em relação à navegação.
E se o trabalho puder ser eliminado, isso parece uma vitória para todos.
Não estou criticando o trabalho feito, ele parece muito bom e, como não sei programar nem para me salvar, não consigo nem começar a apreciar o quanto de trabalho foi feito, ou o quanto mais trabalho minhas sugestões exigiriam.
É bom para documentação mínima, mas falta muita marcação que usei na wiki que linkei. A menos que eu esteja apenas perdendo. Ainda sou bem novo no Discourse.
Por exemplo, não consigo encontrar uma maneira de criar caixas de informação/aviso/erro.
Para auto-hospedados que utilizam este plugin, nossa atualização mais recente exigiria uma reconstrução manual do índice. Isso envolveria a execução desta tarefa rake:
bundle exec rake doc_categories:build_sidebar
# se a execução da tarefa acima falhar devido a NoDatabaseError,
# execute com o seguinte para configurações típicas auto-hospedadas
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar
Se você não conseguir executar esta tarefa rake, poderá ir às configurações de cada categoria de documentação, remover o índice da categoria, salvar, adicioná-lo de volta e salvar. Isso os reconstruiria e também atualizaria o cache da categoria.
Por que estamos fazendo isso?
Anteriormente, quando a barra lateral precisava ser preenchida, analisávamos cada tópico do índice em tempo real e os armazenávamos em cache. Esta atualização move os índices existentes para serem suportados pelo banco de dados em vez de um tópico. Fazer isso expõe nossa equipe a mais opções ao pensar em maneiras de melhorar a experiência do usuário na organização do índice.
Atualizações para auto-hospedados