This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
Summary
Discourse Docs provides the ability to find and filter knowledge base topics
The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. It’s a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.
Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.
For the change to take effect you can either ./launcher rebuild app or, as it’s an environment variable, you can ./launcher destroy app && ./launcher start app to minimise downtime. There’s a little more info on that here - Set Environmental Variables
You may also want to change the site display text as well to match. You can search for all instances of ‘docs’ from your /admin/customize/site_texts page, but the main ones would be:
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!
This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
