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 |
 |
Link do Repositório | https://github.com/discourse/discourse-docs |
 |
Guia de Instalação | Como instalar plugins no Discourse |
Recursos
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.
Precisa encontrar um tópico da base de conhecimento de outro lugar no Discourse? Use o novo auxiliar de pesquisa: in:kb.
Configuração
-
Ative o plugin ativando a configuração
docs enabled(docs ativado). -
Adicione categorias e tags às configurações
docs categories(categorias de docs) edocs tags(tags de docs). -
Encontre o link Docs no menu de navegação.
- Lucre com o acesso mais fácil ao conhecimento!
Configurações
| Nome | Descrição |
|---|---|
| docs enabled | Ativa o Plugin Docs |
| docs categories | 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:
- js.docs.title
- js.sidebar.docs_link_text
Hospedado por nós? A renomeação do caminho
/docsestá disponível apenas em nosso plano Enterprise. Entre em contato conosco se quiser saber mais.
Histórico de Desenvolvimento
O plugin Docs foi uma continuação do Componente de Tema Knowledge Explorer.