Discourse-Dokumentenkategorien

[cmdntd]

Könnte ich hier einen externen Link verwenden? Und _blank zum Öffnen eines neuen Tabs verwenden?

Sie können mit einer optionalen kurzen Beschreibung der Kategorie beginnen.

## Externer Test
* Google: https://google.com

## Erster Abschnitt
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Kurzer Titel: https://discourse.example.com/t/topic-with-a-long-title/56
* Anderer Titel: https://discourse.example.com/t/another-topic-with-a-long-title/78

## Zweiter Abschnitt
* Titel des Themas: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76

[Heliosurge (Dan DeMontmorency)]

@yari

Sehr geehrter @Moin, ich hatte keine Probleme bei der Installation. Ich habe nur gefragt, ob das Plugin geeignet ist oder nicht. Danke.

Nicht unterstützte Installationen erhalten normalerweise einen Link zu nicht unterstützten Installationen. Als Haftungsausschluss, da alle Probleme teilweise damit zusammenhängen könnten.

Plugins, Themes und Theme-Komponenten haben normalerweise eine Datei bezüglich der Versionskompatibilität.

Siehe unten

Das Öffnen dieser Datei liefert wichtige Versionskompatibilitätshinweise. Andere haben es möglicherweise in der Beschreibung. Zum Beispiel hat das Plugin „Category Moderators“ den Haftungsausschluss, dass nur der stabile Zweig unterstützt wird.

Pavilion gibt die empfohlene Häufigkeit von Discourse-Updates an, um sicherzustellen, dass sie Zeit haben, ihre Add-ons zu aktualisieren.

[Al_Whitworth]

Funktioniert das auch für Unterkategorien? Ich habe eine Website mit 6 Kernkategorien, möchte aber Dokumentationen für jede Kategorie sowie Diskussionen. Ich bin mir nicht sicher, wie ich das am besten erreichen kann.

[tvavrda (Tomas Vavrda)]

Das tut es. Sie können es hier unter Documentation sehen. Die Hauptkategorie ist im Grunde ein Inhaltsverzeichnis für die Unterkategorien.

[marvi]

Ich bin gerade darauf gestoßen und habe ein paar Fragen dazu: Wie können wir es auf unserer Cloud-gehosteten Website installieren? Und wie lange wird es die alten Docs noch geben, denken Sie?

[hugh (Hugh Lashbrooke)]

@marvi

wie lange wird es die alten Docs noch geben, denkst du?

Wir haben noch keinen Zeitplan für die vollständige Entfernung des alten Plugins, aber es wird nicht mehr aktiv entwickelt. Sobald wir einige Entscheidungen dazu getroffen haben, werden wir eine entsprechende Ankündigung machen, damit alle informiert sind!

@marvi

Wie können wir es auf unserer Cloud-gehosteten Website installieren?

Da dieses Plugin noch #experimentell ist, ist es auf unserem Hosting nicht verfügbar. Wir diskutieren dies jedoch derzeit intern und prüfen, ob wir dieses Plugin verfügbar machen können. Wir werden uns hier wieder melden, sobald wir zu einem Schluss gekommen sind.

[alltiagocom (Tiago)]

Ich werde das hier für andere hinzufügen, die es vielleicht verwirrend finden, wie ich, was das Plugin wirklich tut.

Bei all den Einstellungen und dem Index-Thema usw. kann es überwältigend sein, zusätzlich zu dem Versuch zu verstehen, was getan werden kann, wie es verwendet werden kann usw. Zumindest war ich etwas verwirrt, bis ich einen Weg fand, es zu verstehen (wenn ich hier etwas vermisse, teile es mir gerne mit).

Also im Grunde sehe ich es so: Erstellen Sie Ihre Kategorien so, wie Sie sie möchten, und dann entfernt dieses Plugin einfach die Standard-Seitenleiste (mit den Abschnitten für Kategorien, Tags usw.) und ersetzt sie durch eine Liste von Abschnitten und Links innerhalb dieser Abschnitte zu Themen, Kategorien, externen Links usw. Es ist für mich einfacher, es so zu betrachten. Es konzentriert sich mehr auf die Anpassung der Seitenleiste, wenn eine bestimmte Kategorie besucht wird. Etwas wie: Wenn Kategorie A besucht wird, ersetzen Sie die Standard-Seitenleiste durch diese benutzerdefinierte Seitenleiste, die vom Index-Thema bereitgestellt wird. Einfach.

[satonotdead]

Ich frage mich, wie man das Seitenleisten-Index in Docs auf Mobilgeräten sichtbarer machen kann, da die Nutzer die Themen erst sehen, wenn sie auf das Hamburger-Symbol klicken.

Es ist auf dem Desktop wunderbar; leider verwenden die meisten ihre Smartphones.

[Jagster (Jakke Lehtonen)]

Es gibt nicht allzu viele Optionen, oder ich würde sagen, es gibt überhaupt keine Optionen. Handys haben einfach nicht genug Platz.

Das ist ein Grund, warum ich darüber nachdenke, Docs komplett zu verlassen. Von meinen Nutzern verwenden etwa 95 % Handys, und sie nutzen die Seitenleiste sehr selten oder gar nicht. Daher ist die Pflege des Dokumentationsmenüs ziemlich zeitaufwendig und ich glaube nicht, dass das Verhältnis von Zeitaufwand zu Nutzen ausgewogen ist

[satonotdead]

Ich denke, dass die Verlagerung des Hamburger-Icons nach links (wie auf dem Desktop) die Benutzererfahrung ein wenig verbessern sollte.

Docs sind sehr leistungsfähig, ich möchte sie nicht deaktivieren, aber sie werden von unseren Benutzern fast nicht genutzt, weil die Indizes versteckt sind (!).

[Heliosurge (Dan DeMontmorency)]

Dieses Theme component könnte von Interesse sein

Left side hamburger menu on mobile

One thing we never got around to and caused some confusion after our work on Full height, slide out hamburger menu was that the hamburger menu, on the right side, opens a menu from the left side. For those interested in rearranging the header, this is for you: [Screenshot from 2020-09-18 12-19-27] Mobile menus appearing in the upper-left corner of the screen is not very reachable single-handedly which is why this is a standalone theme component. Options, yanno? R…

[tknospdr (David Muszynski)]

Okay, ich habe diese ganze Diskussion durchgelesen und habe ein paar Fragen. Ich verstehe, dass die Struktur dieser Seite durch diese Seite erstellt wird, aber dann braucht man auch eine Indexseite für jede Unterkategorie? Der Index für diese Seite muss riesig sein… oder für jede der anderen mit einer Menge Artikeln.

Wie schwierig wäre es, ein xwiki-ähnliches Layout für Seiten zu implementieren, die Teil der Dokumentation einer Discourse-Site sind. Die Benutzeroberfläche ist einfach genug, Sie aktivieren das Kontrollkästchen bei der Seitenerstellung, das besagt, dass diese Seite eine Dokumentation ist. Jetzt fragt es Sie einfach, was die übergeordnete Seite ist. Keine übergeordnete Seite? Es ist ein Top-Level-Thema. Sie legen eine übergeordnete Seite fest, und die Seite wird unter diesem Thema/dieser Kategorie angezeigt. Dies eliminiert vollständig die Notwendigkeit, Indexseiten manuell zu pflegen. Sie sehen nach viel zusätzlicher Arbeit aus, die nicht notwendig sein sollte. Und es ist leicht zu übersehen, Dinge hinzuzufügen, wenn sie erstellt werden.

Wenn Sie zu https://checkin.technospider.com gehen und einige der Elemente in der Seitenleiste aufklappen, können Sie sehen, wie die Verschachtelung in einem realen Beispiel funktioniert. Diese gesamte Seitenleiste wird einfach dynamisch generiert, indem Seiten unter anderen Seiten verschachtelt werden (Eltern-/Kind-Beziehung). Diese Seite hat nur etwa 150 Seiten, aber es hätte doppelt so lange gedauert, bis ich sie fertiggestellt hätte, wenn ich Indizes erstellen müsste, um all das zu erstellen.

Und das bringt mich zu einem UI/UX-Problem mit der Anordnung der Docs-Seitenleiste. Sobald Sie von der Hauptseite wegklicken, verlieren Sie die anfängliche Liste der Kategorien. Sie sollten eine Möglichkeit haben, auf der Seite irgendwo zurückzukehren.
Jeder Ihrer 8 Hauptbereiche sollte Ausklappdreiecke haben, sodass, egal ob Sie auf das Kästchen auf der Hauptseite oder auf den Namen in der Seitenleiste klicken, es einfach herunterklappt und Sie die Möglichkeit, direkt auf einen anderen der Hauptbereiche zu klicken, nicht verlieren.
Sie haben auf jedem Endartikel einen Breadcrumb, aber selbst der fehlt bei den 8 Kategorien. Wenn Sie oben auf der Seite bei den Unterkategorien auf ‘Filter entfernen’ klicken, komme ich zurück, aber das ist sehr unintuitiv. Und Sie können seltsame Dinge tun, indem Sie mit den Filtern spielen, zum Beispiel verschwindet das schöne grüne Banner, wenn Sie auf ‘keine Unterkategorien’ klicken.

[NiceOldGuy (Shap Wolf)]

@tknospdr

Der Index für diese Seite muss riesig sein…

Ja, das ist für Site-Management-Themen, die Indexseite ist hier. (index ist ein Tag, der alle Indexseiten anzeigt)

Ich stimme zu, dass es viel Arbeit gekostet haben muss, all die Seitenlinks zusammenzutragen und sie schön in Kategorien mit Beschriftungen zu sortieren. Aber das Ergebnis ist so verdammt gut und brauchbar!

[tknospdr (David Muszynski)]

[Zitat=“NiceOldGuy, Beitrag:113, Thema:322376”]
Aber das Ergebnis ist so verdammt schön und nützlich!
[/Zitat]

Es sieht definitiv schön aus, aber wie ich bereits sagte, gibt es einige Usability-Probleme in Bezug auf die Navigation.
Und wenn die Arbeit, die darin steckt, eliminiert werden kann, scheint das für alle ein Gewinn zu sein.

Ich kritisiere nicht die geleistete Arbeit, sie sieht sehr schön aus, und da ich nicht programmieren kann, um mein Leben zu retten, kann ich kaum einschätzen, wie viel Arbeit darin steckt oder wie viel mehr Arbeit meine Vorschläge wären.

Es ist gut für minimale Dokumentationen, aber es fehlt eine Menge Markup, das ich auf dem Wiki benutzt habe, auf das ich verlinkt habe. Es sei denn, ich übersehe es nur. Ich bin noch ziemlich neu bei Discourse.

Zum Beispiel finde ich keinen Weg, um Info/Warnung/Fehlerboxen zu erstellen.

[Moin]

@tknospdr

Zum Beispiel finde ich keinen Weg, Info-/Warn-/Fehlerfelder zu erstellen.

Hier auf Meta werden Blockzitate und Emojis verwendet.
Vielleicht passt diese Theme component, die alternative Stile bietet, zu Ihren Bedürfnissen:

Quote Callouts

Summary Adds Obsidian-style callouts as an alternative for markdown quotes. Preview Theme Creator Repository GitHub - Arkshine/discourse-quote-callouts Install Guide How to install a theme or theme component New to Discourse Themes? Beginner’s guide to using Discourse Themes Install this theme component This theme component adds support for Obsidian-style callouts in Discourse as an alternative …

[tknospdr (David Muszynski)]

Danke, das sieht hilfreich aus, sobald die manuelle Indizierung nicht mehr benötigt wird.

[nat (Natalie T)]

Updates für Self-Hosters

Für Self-Hosters, die dieses Plugin verwenden, erfordert unser letztes Update einen manuellen Neuaufbau des Index. Dies würde die Ausführung des folgenden Rake-Tasks beinhalten:

bundle exec rake doc_categories:build_sidebar

# Wenn der obige Task aufgrund eines NoDatabaseError fehlschlägt,
# führen Sie ihn für typische Self-Hosted-Setups mit dem folgenden Befehl aus:
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar

Wenn Sie diesen Rake-Task nicht ausführen können, können Sie zu den Einstellungen jeder Dokumentationskategorie gehen, den Kategorieindex entfernen, speichern, ihn wieder hinzufügen und speichern. Dies würde sie neu aufbauen und auch den Kategorie-Cache aktualisieren.

---

Warum tun wir das?

Zuvor, wenn der Sidebar aufgefüllt werden musste, haben wir jeden Index-Topic “on the fly” geparst und zwischengespeichert. Dieses Update verschiebt die bestehenden Indizes so, dass sie von der Datenbank anstatt von einem Topic unterstützt werden. Dies eröffnet unserem Team mehr Möglichkeiten, wenn es darum geht, die Benutzererfahrung bei der Organisation des Index zu verbessern.