Este plugin está sendo aposentado em favor do plugin experimental Categorias de Documentos. Ainda daremos suporte ao Docs até que o novo plugin deixe de ser considerado experimental.
Resumo
Discourse Docs oferece a capacidade de encontrar e filtrar tópicos da base de conhecimento
O plugin Discourse Docs é uma ferramenta poderosa que transforma seu fórum Discourse em uma base de conhecimento impulsionada pela comunidade. Ele fornece uma seção dedicada de Documentos onde os usuários podem criar, atualizar e curar documentação. Este plugin possui um botão Documentos que permite acesso fácil a essa seção. É uma ótima maneira de aproveitar o conhecimento coletivo da sua comunidade e fornecer um recurso centralizado para informações importantes.
Em essência, o Docs permite uma exibição mais fácil de tópicos no estilo de base de conhecimento em um conjunto definido de categorias e/ou tags.
Filtre a lista por tags, pesquise pela barra de pesquisa e clique nos tópicos para ver a primeira postagem — tudo sem sair do contexto do explorador de conhecimento.
Uma lista de slugs de categoria para incluir nos docs
show tags by group
Organiza tags usando Grupos de Tags. Crie grupos para categorizar tags relacionadas.
docs tag groups
Os Grupos de Tags usados para mostrar tags por grupo
docs tags
Uma lista de tags para incluir nos docs
docs add solved filter
Adiciona um filtro para tópicos resolvidos — requer que o Discourse Solved esteja instalado e ativado
docs add to top menu
Adiciona um link ao menu superior para navegar para a visualização Docs
docs add search menu tip
Adiciona a dica “in:docs” às dicas aleatórias do menu de pesquisa
Combinações Úteis
Renomeando o caminho /docs
Se você tiver acesso ao seu servidor, poderá alterar o caminho do seu link /docs adicionando uma variável de ambiente DISCOURSE_DOCS_PATH: ao seu app.yml:
Para que a alteração entre em vigor, você pode executar ./launcher rebuild app ou, como é uma variável de ambiente, pode executar ./launcher destroy app && ./launcher start app para minimizar o tempo de inatividade. Há mais informações sobre isso aqui - Set Environmental Variables
Você também pode querer alterar o texto de exibição do site para corresponder. Você pode pesquisar todas as instâncias de ‘docs’ na sua página /admin/customize/site_texts, mas as principais seriam:
Recebi o erro abaixo ao executar a especificação. Não alterei nenhum arquivo. Posso ignorar este erro?
➜ discourse git:(main) ✗ LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec
Randomized with seed 57815
...................................F
Failures:
1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Failure/Error: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
expected to find css ".topic-excerpt" but there were no matches
[Screenshot Image]: /xxxx/discourse/discourse/tmp/capybara/failures_r_spec_example_groups_discourse_docs_index_topic_excerpts_when_the_theme_modifier_serialize_topic_excerpts_is_true_shows_the_excerpts_460.png
~~~~~~~ JS LOGS ~~~~~~~
~~~~~ END JS LOGS ~~~~
# ./plugins/discourse-docs/spec/system/docs_index_spec.rb:52:in `block (4 levels) in <main>'
# ./spec/rails_helper.rb:469:in `block (2 levels) in <top (required)>'
Finished in 13.16 seconds (files took 2.79 seconds to load)
36 examples, 1 failure
Failed examples:
rspec ./plugins/discourse-docs/spec/system/docs_index_spec.rb:50 # Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Randomized with seed 57815
Desculpe @JammyDodger, não tive chance de executar o Spec estes dias. Não estou focado no trabalho relacionado ao Discourse Docs, mas em outras coisas no momento. Mas avisarei quando tiver alguma chance.
Este plugin é ótimo para ter todas as nossas categorias de documentos em um só lugar - removendo a necessidade de elas também serem listadas na lista de Categorias (graças ao Discourse Category Hider). No entanto, notamos um problema:
Dentro do plugin/tela de Documentos, você não pode editar documentos existentes ou criar novos - o que significa que você tem que ir para a categoria original para encontrar o tópico/documento para editá-lo… o que significa que você tem que ter o documento acessível em mais de um lugar.
Existe uma maneira de habilitar a edição de tópicos/documentos (se o usuário estiver no Grupo de Usuários correto) dentro do plugin de Documentos?
[quote=“Martyn Thomas, post:351, topic:130172, username:martyn_thomas”]você tem que ir para a categoria original, para encontrar o tópico/documento para editá-lo
[/quote]
Funciona usar o link “ver a discussão sobre este tópico” na parte inferior para navegar até esse tópico e editá-lo?
Olá, tenho um problema que é muito irritante e não sei por que está acontecendo.
Quando crio um documento, ele vai para a área de documentos e funciona como deveria, no entanto, se o documento for editado de alguma forma, o layout do tópico de listagem de documentos volta para o layout padrão do tópico do Discourse ao clicar e não mostra o layout real do documento.
Notei que após alguns minutos ele reverte para o layout do documento do tópico e fica como deveria, há algo que possa estar causando isso?
Observação: também uso o componente de tema “Miniaturas de Tópico” e defino o modo de miniatura de documentos como “lista”.
Encontrei o problema, aparentemente se eu usar Topic List Excerpts ou o componente de tema Topic lists Thumbnails, o href clicável é para a página do tópico do Discourse e não para docs?topic=xxx dos docs da KB, então estou sendo redirecionado para tópicos do Discourse.
Existe uma maneira de manter o caminho da URL na documentação para docs @sam ou devo entrar em contato com @david?
Nossos usuários notaram recentemente um pequeno problema de estilo: quando o navegador tem uma largura de viewport menor, o conteúdo de cada postagem da documentação transborda, como na captura de tela a seguir:
Gostaria de saber se seria melhor recolher automaticamente a barra lateral, se a viewport for menor que o ideal; no entanto, mesmo que eu recolhesse a barra lateral, o conteúdo ainda transbordaria.
Obrigado pelo incrível addon. Tenho uma pergunta: existe uma opção para remover o link do menu hambúrguer de contexto? Eu o adicionei manualmente na seção sempre visível (pois queremos usar essa funcionalidade para exibir conteúdo criado pelo usuário em formato longo, como artigos, etc.) e agora ele aparece duas vezes:
Ambas as opções com fundo mais claro levam a /docs
há alguma chance de termos uma opção para integrar os comentários em uma página de documentação em vez de vincular à postagem e, em seguida, poder comentar?
Eu revisitei o mesmo link em um dispositivo com a mesma largura de viewport. Embora ainda houvesse transbordamento antes de recolher a barra lateral, descobri que, após recolhê-la, não há transbordamento, e a exibição é normal e esteticamente agradável.
Hoje publiquei alguns tópicos na Categoria Docs, mas esses tópicos não são exibidos na página Docs. Desliguei o plugin de docs e ativei o tema novamente, mas esses tópicos ainda não são exibidos.
Obrigado!
Este plugin está sendo aposentado em favor do plugin experimental Categorias de Documentos. Ainda daremos suporte ao Docs até que o novo plugin deixe de ser considerado experimental.
Hospedado por nós? A renomeação do caminho
