Questo plugin verrà dismesso a favore del plugin sperimentale Doc Categories. Continueremo a supportare Docs fino a quando il nuovo plugin non sarà considerato stabile.
 |
Sintesi | 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 alimentata dalla community. Fornisce una sezione Docs dedicata dove gli utenti possono creare, aggiornare e curare la documentazione. Questo plugin include un pulsante Docs che consente un facile accesso a questa sezione. È un ottimo modo per sfruttare la conoscenza collettiva della tua community e fornire una risorsa centralizzata per informazioni importanti.
In sintesi, Docs permette di far emergere più facilmente gli argomenti in stile knowledge base all’interno di un insieme definito di categorie e/o tag.
Filtra la lista per tag, cerca tramite la barra di ricerca e clicca sugli argomenti per visualizzare il primo post, il tutto senza uscire dal contesto dell’esploratore della knowledge base.
Hai bisogno di trovare un argomento della knowledge base da un’altra parte di 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 link Docs nel menu di navigazione.
- Goditi un accesso più semplice alla conoscenza!
Impostazioni
| Nome | Descrizione |
|---|---|
| docs enabled | Abilita il plugin Docs |
| docs categories | Una lista di slug di categorie da includere in docs |
| show tags by group | Organizza i tag usando i Tag Groups. Crea gruppi per categorizzare i tag correlati. |
| docs tag groups | I Tag Groups usati per mostrare i tag per gruppo |
| docs tags | Una lista di 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 |
Combinazioni Utili
Rinominare il percorso /docs
Se hai accesso al tuo server, puoi modificare il percorso del link /docs aggiungendo una variabile d’ambiente DISCOURSE_DOCS_PATH: al tuo file app.yml:
Per rendere effettiva la modifica, puoi eseguire ./launcher rebuild app oppure, trattandosi di una variabile d’ambiente, puoi usare ./launcher destroy app && ./launcher start app per minimizzare i tempi di inattività. Puoi trovare ulteriori informazioni qui: Set Environmental Variables
Potresti voler modificare anche il testo visualizzato sul sito per mantenerlo coerente. Puoi cercare tutte le occorrenze di ‘docs’ dalla tua pagina /admin/customize/site_texts, ma le principali sono:
- js.docs.title
- js.sidebar.docs_link_text
/docsè disponibile solo nel nostro piano Enterprise. Contattaci se desideri ulteriori informazioni.
Storia dello Sviluppo
Il plugin Docs è stato una continuazione del Knowledge Explorer Theme Component.