This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
Summary
Discourse Docs provides the ability to find and filter knowledge base topics
The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. It’s a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.
Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.
For the change to take effect you can either ./launcher rebuild app or, as it’s an environment variable, you can ./launcher destroy app && ./launcher start app to minimise downtime. There’s a little more info on that here - Set Environmental Variables
You may also want to change the site display text as well to match. You can search for all instances of ‘docs’ from your /admin/customize/site_texts page, but the main ones would be:
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!
This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
