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:
Ich habe beim Ausführen des Specs den folgenden Fehler erhalten. Ich habe keine Dateien geändert. Kann ich diesen Fehler ignorieren?
➜ discourse git:(main) ✗ LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec
Zufällig mit Seed 57815
...................................F
Fehler:
1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
Fehler/Fehler: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
Es wurde erwartet, css ".topic-excerpt" zu finden, aber es gab keine Treffer.
[Screenshot-Bild]: /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)>'
Fertig in 13,16 Sekunden (Dateien zum Laden benötigten 2,79 Sekunden)
36 Beispiele, 1 Fehler
Fehlgeschlagene Beispiele:
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
Zufällig mit Seed 57815
Tut mir leid @JammyDodger, ich hatte in letzter Zeit keine Gelegenheit, die Spezifikation auszuführen. Ich konzentriere mich in letzter Zeit nicht auf die Arbeit im Zusammenhang mit Discourse Docs, sondern auf andere Dinge. Aber ich werde Sie informieren, wenn ich eine Gelegenheit dazu bekomme.
Dieses Plugin ist großartig, um alle unsere Dokumentenkategorien an einem Ort zu haben – wodurch die Notwendigkeit entfällt, sie auch in der Kategorienliste aufzuführen (danke Discourse Category Hider). Wir haben jedoch ein Problem festgestellt:
Innerhalb des Docs-Plugins/Bildschirms können Sie keine vorhandenen Dokumente bearbeiten oder neue erstellen – das bedeutet, dass Sie zur ursprünglichen Kategorie gehen müssen, um das Thema/Dokument zum Bearbeiten zu finden … was bedeutet, dass das Dokument an mehreren Stellen zugänglich sein muss.
Gibt es eine Möglichkeit, die Bearbeitung von Themen/Dokumenten (wenn der Benutzer in der richtigen Benutzergruppe ist) innerhalb des Docs-Plugins zu ermöglichen?
[quote=“Martyn Thomas, post:351, topic:130172, username:martyn_thomas”]Sie müssen zur ursprünglichen Kategorie gehen, um das Thema/Dokument zu finden und es zu bearbeiten.
[/quote]
Funktioniert es, den Link „Diskussion zu diesem Thema anzeigen“ unten zu verwenden, um zu diesem Thema zu navigieren und es zu bearbeiten?
Hallo, ich habe ein Problem, das wirklich nervig ist und ich weiß nicht, warum es passiert.
Wenn ich ein Dokument erstelle, wird es im Dokumentenbereich angezeigt und funktioniert wie erwartet. Wenn das Dokument jedoch in irgendeiner Weise bearbeitet wird, wechselt das Dokumenten-Listing-Thema-Layout beim Klicken zurück zum Standard-Discourse-Thema-Layout und zeigt nicht das tatsächliche Dokumenten-Layout an.
Ich habe bemerkt, dass es nach ein paar Minuten zum Thema-Dokumenten-Layout zurückkehrt und so aussieht, wie es sollte. Könnte etwas dies verursachen?
Hinweis: Ich verwende auch die Theme-Komponente „Topic Thumbnails“ und stelle den Dokumenten-Thumbnail-Modus auf „Liste“.
Problem gefunden, anscheinend, wenn ich die Theme-Komponenten Topic List Excerpts oder Topic lists Thumbnails verwende, ist der klickbare Link für die Discourse-Themenseite und nicht für die KB-Dokumentation?topic=xxx, sodass ich zu Discourse-Themen weitergeleitet werde.
Gibt es eine Möglichkeit, den URL-Pfad bei den Dokumenten zu docs beizubehalten, @sam, oder sollte ich mich an @david wenden?
Unsere Nutzer haben kürzlich ein kleines stilistisches Problem bemerkt: Wenn der Browser eine geringere Viewport-Breite hat, wird der Inhalt jedes Doku-Posts überlaufen, wie im folgenden Screenshot zu sehen ist:
Ich frage mich, ob es besser wäre, die Seitenleiste automatisch auszublenden, wenn der Viewport nicht ideal ist. Selbst wenn ich die Seitenleiste ausblenden würde, würde der Inhalt immer noch überlaufen.
Vielen Dank für das wunderbare Addon. Eine Frage jedoch: Gibt es eine Option, den Link aus dem Kontext-Hamburger-Menü zu entfernen? Ich habe ihn manuell im immer sichtbaren Bereich hinzugefügt (da wir diese Funktionalität nutzen möchten, um langformatige, von Benutzern erstellte Inhalte wie Artikel usw. zu präsentieren) und nun wird er zweimal angezeigt:
Beide Optionen mit hellerem Hintergrund führen zu /docs
Gibt es eine Möglichkeit, die Kommentare auf einer Dokumentationsseite zu integrieren, anstatt auf den Beitrag zu verlinken und dann kommentieren zu können?
Ich habe denselben Link auf einem Gerät mit derselben Viewport-Breite erneut aufgerufen. Während es vor dem Einklappen der Seitenleiste immer noch zu Überläufen kam, stellte ich fest, dass es nach dem Einklappen keinen Überlauf mehr gab und die Anzeige normal und ästhetisch ansprechend war.
Heute habe ich einige Themen in der Kategorie Docs gepostet, aber diese Themen werden nicht auf der Docs-Seite angezeigt. Ich habe das Docs-Plugin deaktiviert und das Theme wieder aktiviert, aber diese Themen werden immer noch nicht angezeigt.
Vielen Dank!
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.
