Bitte dokumentieren Sie das Discourse Calendar Plugin besser

Diskussion fortgesetzt von Discourse Calendar — da mein Beitrag dort nach einem Monat automatisch gelöscht wird.

Der oberste Beitrag, der dieses Plugin beschreibt, muss überarbeitet werden. Er ist wirklich verwirrend. Insbesondere:

Event-Verwirrung

Es scheint drei separate Dinge zu geben, die alle „Event“ genannt werden:

1. Am grundlegendsten: eine Antwort mit einem [date], die in einem Kalender im ersten Beitrag des Themas angezeigt wird.
2. Ein erster Beitrag eines Themas, der [event] enthält, verwendet für die optionale „Alpha-Status“-Funktion hier separat beschrieben.
3. Ein völlig separates Plugin mit einem ähnlichen Namen: Events statt Event.

Das ist… verwirrend.

Unklare Syntax für das grundlegende Einzelthema-Event

1. Wie legt man den Namen des Events fest? Die Plugin-Beschreibung zeigt Text mit Events, aber nicht, wie dieser tatsächlich festgelegt wurde.
2. Wie erstellt man wiederkehrende Events?
3. Der Feiertagskalender zeigt Farben. Kann der normale Kalender auch Farben haben, und wenn ja, wie?
4. Die separate „Events“-Funktion kann anscheinend einen iCal-Feed erzeugen. Kann das ein „grundlegender“ Kalender auch?

Weitere Fragen zum Feiertagskalender

Verwendet dieser die gleiche Syntax wie der Kalender pro Thema oder den „Event“-Kalender? Ist er auf „Mitarbeiterfeiertage“ beschränkt oder könnte er von jedem verwendet werden, der auf ein bestimmtes Thema antworten kann? Woher kommen die Farben? Ist das „Holiday flair“-Emoji änderbar? Ist es möglich, dies für jeden oder eine beliebige Gruppe sichtbar zu machen und nicht nur für Mitarbeiter?

Usw…

Einiges davon habe ich selbst herausgefunden oder durch Nachfragen beim Support. Aber es muss wirklich in der Plugin-Dokumentation des Themas dokumentiert werden.

Es wäre wahrscheinlich auch gut, einige der Einschränkungen zu erläutern — der Wochenstartdatum folgt nicht Ihrer Locale und ist nicht konfigurierbar, das Ganze ist verwirrt über Zeitzonen … und wenn es eine Roadmap oder Pläne gibt, einige dieser Dinge anzugehen oder neue Funktionen hinzuzufügen (oder wenn nicht!), sagen Sie das bitte auch.

Danke! Dies ist eine nette kleine Discourse-Funktion, die für viele Leute sehr nützlich sein könnte, aber sie ist auch ziemlich verwirrend.

Dieser Beitrag ist ein Wiki – Sie können also leicht Ihre eigenen Beiträge dazu leisten. Das wäre für alle sehr hilfreich.

Ich kann, obwohl einige Dinge nur Vermutungen sein werden!

Ich habe dies in „Verwandte Themen“ entdeckt, als ich die Themen Kalender und Ereignisse (ein weiterer Erfolg für „Verwandte Themen“ ) durchgesehen habe.

Ich habe sie gerade neu arrangiert, sodass beide Funktionen nun ordnungsgemäß als ein Plugin-Thema erscheinen, was hoffentlich einige Verwirrung beseitigen sollte:

Ich habe auch viele der „Anleitungs“-Details in ein paar Anleitungen aufgeteilt, um ihnen etwas mehr Raum zu geben:

Der Hauptaugenmerk lag darauf, ihnen eine konsistentere Struktur zu geben (obwohl ich zur Sicherheit auch eine schnelle Auffrischung vorgenommen habe). Es war etwas knifflig, sie zu glätten, aber ich denke, sie sind jetzt besser in Form als zuvor. Nachdem ich darüber geschlafen habe, denke ich, dass es noch ein paar Dinge gibt, die ich gerne tun würde, daher werde ich noch nicht den auspacken.

Aber hoffentlich bewegen wir uns in die richtige Richtung.