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
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.
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:
Ho ricevuto il seguente errore durante l’esecuzione dello spec. Non ho modificato alcun file. Posso ignorare questo errore?
➜ 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
Mi dispiace @JammyDodger, non ho avuto modo di eseguire lo Spec in questi giorni. Al momento non mi occupo del lavoro relativo a Discourse Docs, ma di altre cose. Ti farò sapere quando ne avrò l’occasione.
Questo plugin è ottimo per avere tutte le nostre categorie di documenti in un unico posto, eliminando la necessità che siano elencate anche nell’elenco delle Categorie (grazie a Discourse Category Hider). Tuttavia, abbiamo notato un problema:
All’interno del plugin/schermata Docs non è possibile modificare documenti esistenti o crearne di nuovi, il che significa che devi andare alla categoria originale per trovare l’argomento/documento da modificare… il che significa che devi avere il documento accessibile in più di un posto.
C’è un modo per abilitare la modifica di argomenti/documenti (se l’utente appartiene al gruppo Utente corretto) all’interno del plugin Docs?
[quote=“Martyn Thomas, post:351, topic:130172, username:martyn_thomas”]devi andare alla categoria originale, per trovare l’argomento/documento per modificarlo
[/quote]
funziona usare il link “visualizza la discussione su questo argomento” in fondo per navigare a quell’argomento e modificarlo?
Ciao, ho un problema che è davvero fastidioso e non so perché stia succedendo.
Quando creo un documento, va nell’area documenti e funziona come dovrebbe, tuttavia, se il documento viene modificato in qualsiasi modo, l’area del layout del documento nell’elenco dei documenti torna al layout predefinito dell’argomento di discourse al clic e non mostra il layout effettivo del documento.
Ho notato che dopo qualche minuto torna al layout del documento dell’argomento e appare come dovrebbe, c’è qualcosa che potrebbe causare questo?
Nota: utilizzo anche il componente del tema “Miniature dell’argomento” e impostato sulla modalità miniatura dei documenti “elenco”.
Trovato il problema, apparentemente se uso Topic List Excerpts o il componente tematico Topic lists Thumbnails, l’href cliccabile è per la pagina del topic di discourse e non per docs?topic=xxx dei KB docs, quindi vengo reindirizzato ai topic di discourse.
C’è un modo per mantenere il percorso dell’URL sui docs per docs @sam o dovrei contattare @david?
I nostri utenti hanno recentemente notato un piccolo problema di stile: quando il browser ha una larghezza di visualizzazione ridotta, il contenuto di ogni post della documentazione fuoriesce, come nello screenshot seguente:
Mi chiedo se sarebbe meglio collassare automaticamente la barra laterale, se la visualizzazione è inferiore all’ideale; tuttavia, anche se collassassi la barra laterale, il contenuto continuerebbe a fuoriuscire.
Grazie per il fantastico componente aggiuntivo. Una domanda però: c’è un’opzione per rimuovere il link dal menu hamburger contestuale? L’ho aggiunto manualmente nella sezione sempre visibile (poiché vogliamo utilizzare questa funzionalità per mostrare contenuti creati dagli utenti di lunga durata come articoli, ecc.) e ora si ritrova visualizzato due volte:
Entrambe le opzioni con sfondo più chiaro portano a /docs
Ho rivisitato lo stesso link su un dispositivo con la stessa larghezza della viewport. Mentre c’era ancora un overflow prima di collassare la barra laterale, ho scoperto che dopo averla collassata, non c’è più overflow e la visualizzazione è normale ed esteticamente gradevole.
Oggi ho pubblicato alcuni argomenti nella categoria Documenti, ma quegli argomenti non vengono visualizzati nella pagina Documenti. Ho disattivato il plugin Documenti e riattivato il tema, ma quegli argomenti non vengono ancora visualizzati.
Grazie!
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.
