Documentazione Discourse

:warning: Questo plugin sta venendo ritirato a favore del plugin sperimentale Doc Categories. Continueremo a supportare Docs fino a quando il nuovo plugin non sarà più considerato sperimentale.

:discourse2: Riepilogo Discourse Docs offre la possibilità di trovare e filtrare argomenti della knowledge base
:hammer_and_wrench: Link al Repository https://github.com/discourse/discourse-docs
:open_book: Guida all’installazione Come installare i plugin in Discourse

Funzionalità

Il plugin Discourse Docs è uno strumento potente che trasforma il tuo forum Discourse in una knowledge base alimentata dalla comunità. Fornisce una sezione dedicata Docs dove gli utenti possono creare, aggiornare e curare la documentazione. Questo plugin include un pulsante Docs che permette un facile accesso a questa sezione. È un ottimo modo per sfruttare la conoscenza collettiva della tua comunità e fornire una risorsa centralizzata per informazioni importanti.

In sostanza, Docs permette di rendere più semplici gli argomenti in stile knowledge base attraverso un insieme definito di categorie e/o tag.

Filtra l’elenco per tag, cerca tramite la barra di ricerca e clicca sugli argomenti per vedere il primo post: tutto senza uscire dal contesto dell’esploratore della conoscenza.

Devi trovare un argomento della knowledge base da un’altra parte di Discourse? Usa il nuovo assistente di ricerca: in:kb.

Configurazione

  1. Abilita il plugin attivando l’impostazione docs enabled.

  2. Aggiungi categorie e tag alle impostazioni docs categories e docs tags.

  3. Trova il link Docs nel menu di navigazione.

  1. Goditi un accesso più semplice alla conoscenza!

Impostazioni

Nome Descrizione
docs enabled Abilita il plugin Docs
docs categories Elenco degli slug delle categorie da includere in Docs
show tags by group Organizza i tag utilizzando i gruppi di tag. Crea gruppi per categorizzare tag correlati.
docs tag groups I gruppi di tag utilizzati per mostrare i tag per gruppo
docs tags Elenco dei tag da includere in Docs
docs add solved filter Aggiunge un filtro per gli argomenti risolti – richiede che Discourse Solved sia installato e abilitato
docs add to top menu Aggiunge un link al menu superiore per navigare alla vista Docs
docs add search menu tip Aggiunge il suggerimento “in:docs” ai suggerimenti casuali del menu di ricerca

Abbinamenti utili

Rinominare il percorso /docs

Se hai accesso al tuo server, puoi modificare il percorso del tuo link /docs aggiungendo una variabile d’ambiente DISCOURSE_DOCS_PATH: al tuo file app.yml:

Affinché la modifica abbia effetto, puoi eseguire ./launcher rebuild app oppure, dato che si tratta di una variabile d’ambiente, puoi eseguire ./launcher destroy app && ./launcher start app per ridurre al minimo i tempi di inattività. Ci sono ulteriori informazioni a riguardo qui - Set Environmental Variables

Potresti anche voler modificare il testo visualizzato sul sito per farlo corrispondere. Puoi cercare tutte le istanze di ‘docs’ dalla pagina /admin/customize/site_texts, ma quelle principali sono:

  • js.docs.title
  • js.sidebar.docs_link_text

:discourse2: Ospitato da noi? La rinomina del percorso /docs è disponibile solo nel nostro piano Enterprise. Contattaci se desideri saperne di più.

Cronologia dello sviluppo

Il plugin Docs è una continuazione del Knowledge Explorer Theme Component.


:discourse2: Ospitato da noi? Questo plugin è disponibile su tutti i nostri piani di hosting. https://www.discourse.org/plugins/docs.html

95 Mi Piace
Discourse Doc Categories
Using Posts as a Wiki?
Using Discourse as a internal Knowledge Base / Intranet
Is anyone working on a Discourse Wiki?
Documentation Library
Community glossary?
The Docs button on meta.discourse
Memberful opinions?
Subcategories and tag groups layout
[Paid] Parent/Child Tagging System + Docs Plugin Group Tagging
Discourse Category Lockdown
Filtering by multiple tags
Docs page in Discourse
Mirrored topic: same topic in two categories
Discourse Docs + Pavilion Layouts Plugin
FAQs, less thread-y more article-y
Topic List Previews (TLP)
Email list server?
Recommnded plugins for supporting a tech community run by a big enterprise?
Is it possible to display the thumbnails in Docs?
Customize docs plugin text link
Install discourse doc plugin from Git is failed
What is this component?
Advice on a support forum
Knowledge Base
Grow my community
Published topic with a link to itself in the forum?
Topic List Thumbnails don't play well with Docs
How-to use Discourse for managing a collaborative newsletter?
Is it possible to restrict certain “docs” to appear based on the user’s groups?
Pinning a post to the top of the topic
Knowledge Base
Discourse has slowly been solving a fatigue I didn't realize I had
Documentation in a Discussion forum
Discourse docs search error, 500 error
Discourse docs search error, 500 error
Discourse Docs Plugin – Topics Not Updating in Docs Page
Forum not working after update – what’s missing?
Knowledge Base
Making my discourse site look a certain way
Time tracking using Discourse?
Back button behavior on docs
Workspace Views
New documentation plugin in development
Is anyone here using their Discourse instance as their entire website?
Question Answer Plugin
How to make the recommanded topics collection
New homes for official and community documentation
Is it possible to show tags in place of subcategories?
Disable auto-scroll for certain topics?
Implementing KCS
How can I compare arbitrary revisions of a post?
How to create a page like the official Discourse docs?
Option to use "Docs view" when accessing Docs category from anywhere in Discourse
DiscoTOC - automatic table of contents
When a thread is too important to lose
About this Community and the Docs
Ability to Create Private Templates
Tips into building a community aside a variety of already existing tools
Sidebar for Subcategories
Published page not visible?
Nest subcategories under their parent categories in the sidebar
File/Document Repository?
Creating user guides for your community
Allow plugins (like docs) to add top-level links in sidebar (rather than hide them in More...)