Questo plugin sta venendo ritirato a favore del plugin sperimentale Doc Categories. Continueremo a supportare Docs finché il nuovo plugin non sarà considerato stabile.
 |
Riepilogo | Discourse Docs offre la possibilità di trovare e filtrare gli argomenti della knowledge base |
 |
Link al Repository | https://github.com/discourse/discourse-docs |
 |
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 gestita dalla comunità. Offre una sezione dedicata Docs dove gli utenti possono creare, aggiornare e curare la documentazione. Questo plugin include un pulsante Docs che permette un accesso facile a questa sezione. È un ottimo modo per sfruttare la conoscenza collettiva della tua comunità e fornire una risorsa centralizzata per le informazioni importanti.
In sostanza, Docs permette di rendere più visibili gli argomenti in stile knowledge base in 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 messaggio: tutto senza uscire dal contesto dell’esploratore della knowledge base.
Devi trovare un argomento della knowledge base da un’altra parte in Discourse? Usa il nuovo assistente di ricerca: in:kb.
Configurazione
-
Abilita il plugin attivando l’impostazione
docs enabled. -
Aggiungi categorie e tag alle impostazioni
docs categoriesedocs tags. -
Trova il collegamento Docs nel menu di navigazione.
- 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 usando i Gruppi di Tag. Crea gruppi per categorizzare i 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 collegamento 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 |
Combinazioni Utili
Rinominare il percorso /docs
Se hai accesso al tuo server, puoi modificare il percorso del collegamento /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, poiché 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 le principali sono:
- js.docs.title
- js.sidebar.docs_link_text
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 è un’evoluzione del Componente Tema Knowledge Explorer.