Discourse-Dokumentation

[Discourse]

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

Da dies ein #offizielles Plugin ist, das vom Discourse-Team gepflegt wird, können #Support-, #contribute:bug-, #contribute:ux- und #contribute:feature-Anfragen in den entsprechenden Kategorien hier auf Meta gestellt und mit dem entsprechenden Plugin-Tag versehen werden. Klicken Sie auf einen der untenstehenden Links, um einen zu starten.

 Support  Bug  UX  Feature

Features

Das Discourse Docs-Plugin ist ein leistungsstarkes Tool, das Ihr Discourse-Forum in eine von der Community getragene Wissensdatenbank verwandelt. Es bietet einen dedizierten Docs-Bereich, in dem Benutzer Dokumentation erstellen, aktualisieren und kuratieren können. Dieses Plugin verfügt über einen Docs-Button, der einen einfachen Zugriff auf diesen Bereich ermöglicht. Es ist ein großartiger Weg, das kollektive Wissen Ihrer Community zu nutzen und eine zentrale Ressource für wichtige Informationen bereitzustellen.

Im Wesentlichen ermöglicht Docs das einfachere Auffinden von wissensdatenbankartigen Themen in einer definierten Menge 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 zu sehen – alles ohne den Kontext des Wissens-Explorers zu verlassen.

Müssen Sie ein Wissensdatenbank-Thema von einer anderen Stelle in Discourse aus finden? Nutzen Sie den neuen Suchassistenten: in:kb.

Konfiguration

1. Aktivieren Sie das Plugin, indem Sie die Einstellung docs enabled aktivieren.

2. Fügen Sie Kategorien und Tags zu den Einstellungen docs categories und docs tags hinzu.

3. Finden Sie den Docs-Link im Navigationsmenü.

4. Profitieren Sie von einem einfacheren Zugriff auf Wissen!

Einstellungen

Name	Beschreibung
docs enabled	Aktiviert das Docs-Plugin
docs categories	Eine Liste von Kategorie-Slugs, die in Docs enthalten sein sollen
show tags by group	Organisiert Tags mit Hilfe von Tag-Gruppen. 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 von Tags, die in Docs enthalten sein sollen
docs add solved filter	Fügt einen Filter für gelöste Themen hinzu – erfordert, dass Discourse Solved installiert und aktiviert ist
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 Suchmenü-Tipps hinzu

Nützliche Kombinationen

Discourse Docs Kartenfilter

Zusammenfassung Der Discourse Docs Card Filter ist für das Discourse Docs Plugin gedacht und ermöglicht es Ihnen, „Karten“ zu platzieren, die als anklickbarer Filter dienen, um bei der Eingabe der /docs-Seite durch Ihre Nutzer schnellere Filterergebnisse zu liefern. Vorschau Vorschau im Discourse Theme Creator Repository-Link https://github.com/discourse/discourse-docs-card-filter Neu bei Discourse-Themes? Einsteigeranlei…

Umbenennung des /docs-Pfads

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 die Ausfallzeit zu minimieren. Weitere Informationen dazu finden Sie hier – Set Environmental Variables

Möglicherweise möchten Sie auch den Anzeigetext der Site entsprechend anpassen. Sie können nach allen Instanzen von „docs“ auf Ihrer /admin/customize/site_texts-Seite suchen, aber die wichtigsten wären:

• js.docs.title
• js.sidebar.docs_link_text

Von uns gehostet? Das Umbenennen des /docs-Pfads ist nur in unserem Enterprise-Plan verfügbar. Kontaktieren Sie uns bitte, wenn Sie mehr erfahren möchten.

Entwicklungsgeschichte

Das Docs-Plugin war eine Fortsetzung des Knowledge Explorer Theme Components.

[Hyan]

Hallo Discourse-Community,

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

[JammyDodger]

Konnten Sie das Problem lösen, @Hyan?

[tpetrov (Toni Petrov)]

Hey Sam, wäre es aus SEO-Sicht nicht sinnvoll, wenn die rel=canonical der Themen auf das Originalthema verweisen würden? Z.B. Dark/Light Mode Toggle - theme-component - Docs - Discourse Meta → Dark/Light Mode Toggle - theme-component - Discourse Meta? Ich frage mich, ob sich die beiden Versionen der Seite nicht gegenseitig in Googles Algorithmen kannibalisieren.

[sam (Sam Saffron)]

Ja, absolut, wir sollten dort etwas tun

[Hyan]

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.

[martyn_thomas]

Gibt es eine Möglichkeit, das Symbol neben “Docs” im Hamburger-Menü von Link/Kette zu etwas anderem zu ändern?

[martyn_thomas]

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?

[Moin]

[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?

[digitaldominica]

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“.

[digitaldominica]

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?

[civitas_john (John Chen)]

Hallo,

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.

[Nebthtet]

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

[Arkshine]

Ich denke, du kannst es hier mit etwas CSS ausblenden:

.sidebar-section-link-wrapper[data-list-item-name="docs"] {
    display: none;
}

[Nebthtet]

Funktionierte perfekt! Vielen Dank!

[rly]

Gibt es eine Möglichkeit, die Kommentare auf einer Dokumentationsseite zu integrieren, anstatt auf den Beitrag zu verlinken und dann kommentieren zu können?

[wsxiaolin]

@civitas_john

Selbst wenn ich die Seitenleiste einklappe, tritt der Inhalt immer noch über.

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.

[supermathie (Michael Brown)]

Ich bin überrascht, dass die Standard-Suchreihenfolge in Docs nicht „Relevanz“ ist, sondern „Aktivitätsdatum“.

Ist es möglich, nach Relevanz zu suchen?

[thaidb]

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!