Dieses Plugin wird zugunsten des experimentellen Doc Categories Plugins eingestellt. Wir werden Docs weiterhin unterstützen, bis das neue Plugin nicht mehr als experimentell gilt.
 |
Zusammenfassung | Discourse Docs bietet die Möglichkeit, Wissensdatenbank-Themen zu finden und zu filtern |
 |
Repository-Link | https://github.com/discourse/discourse-docs |
 |
Installationsanleitung | So installieren Sie Plugins in Discourse |
Funktionen
Das Discourse Docs-Plugin ist ein leistungsstarkes Werkzeug, das Ihr Discourse-Forum in eine gemeinschaftsbasierte Wissensdatenbank verwandelt. Es bietet einen dedizierten Docs-Bereich, in dem Benutzer Dokumentation erstellen, aktualisieren und kuratieren können. Dieses Plugin verfügt über eine Docs-Schaltfläche, die den einfachen Zugriff auf diesen Bereich ermöglicht. Es ist eine großartige Möglichkeit, das kollektive Wissen Ihrer Community zu nutzen und eine zentrale Ressource für wichtige Informationen bereitzustellen.
Im Wesentlichen ermöglicht Docs eine einfachere Auffindbarkeit von Themen im Stil einer Wissensdatenbank über einen definierten Satz von Kategorien und/oder Tags.
Filtern Sie die Liste nach Tags, suchen Sie über die Suchleiste und klicken Sie auf Themen, um den ersten Beitrag anzuzeigen – alles, ohne den Kontext des Wissens-Explorers zu verlassen.
Müssen Sie ein Thema aus der Wissensdatenbank von einer anderen Stelle in Discourse finden? Nutzen Sie den neuen Such-Assistenten: in:kb.
Konfiguration
-
Aktivieren Sie das Plugin, indem Sie die Einstellung
docs enabledeinschalten. -
Fügen Sie Kategorien und Tags zu den Einstellungen
docs categoriesunddocs tagshinzu. -
Finden Sie den Docs-Link im Navigationsmenü.
- Profitieren Sie vom einfacheren Zugriff auf Wissen!
Einstellungen
| Name | Beschreibung |
|---|---|
| docs enabled | Das Docs-Plugin aktivieren |
| docs categories | Eine Liste der Kategorie-Slugs, die in Docs enthalten sein sollen |
| show tags by group | Tags mithilfe von Tag-Gruppen organisieren. Erstellen Sie Gruppen, um verwandte Tags zu kategorisieren. |
| docs tag groups | Die Tag-Gruppen, die verwendet werden, um Tags nach Gruppen anzuzeigen |
| docs tags | Eine Liste der Tags, die in Docs enthalten sein sollen |
| docs add solved filter | Fügt einen Filter für gelöste Themen hinzu – erfordert die Installation und Aktivierung von Discourse Solved |
| docs add to top menu | Fügt einen Link zum oberen Menü hinzu, um zur Docs-Ansicht zu navigieren |
| docs add search menu tip | Fügt den Tipp „in:docs“ zu den zufälligen Tipps im Suchmenü hinzu |
Nützliche Kombinationen
Umbenennung des /docs-Pfad
Wenn Sie Zugriff auf Ihren Server haben, können Sie den Pfad Ihres /docs-Links ändern, indem Sie eine DISCOURSE_DOCS_PATH:-Umgebungsvariable zu Ihrer app.yml hinzufügen:
Damit die Änderung wirksam wird, können Sie entweder ./launcher rebuild app ausführen oder, da es sich um eine Umgebungsvariable handelt, ./launcher destroy app && ./launcher start app ausführen, um Ausfallzeiten zu minimieren. Weitere Informationen dazu finden Sie hier: Set Environmental Variables
Möglicherweise möchten Sie auch den angezeigten Text auf der Website ändern, damit er übereinstimmt. Sie können alle Vorkommen von „docs“ auf Ihrer Seite /admin/customize/site_texts durchsuchen, aber die wichtigsten sind:
- js.docs.title
- js.sidebar.docs_link_text
Von uns gehostet? Das Umbenennen des
/docs-Pfads ist nur in unserem Enterprise-Plan verfügbar. Bitte kontaktieren Sie uns, wenn Sie mehr erfahren möchten.
Entwicklungsgeschichte
Das Docs-Plugin war eine Weiterentwicklung des Knowledge Explorer Theme Component.