Migliorare la documentazione del plugin Discourse Calendar

[mattdm (Matthew Miller)]

Continuando la discussione da Discourse Calendar — poiché il mio post lì verrà eliminato automaticamente dopo un mese.

Il post principale che descrive questo plugin necessita di qualche lavoro. È davvero confuso. Nello specifico:

Confusione sugli eventi

Sembrano esserci tre cose separate chiamate tutte “evento”:

1. La più basilare: una risposta con una [data], che viene mostrata in un calendario nel primo post dell’argomento.
2. Un primo post in un argomento che contiene [event], utilizzato dalla funzionalità opzionale “stato alfa” descritta separatamente qui.
3. Un plugin completamente separato con un nome simile: Events invece di Event.

Questo è… confuso.

Sintassi poco chiara per l’evento singolo di base

1. Come si imposta il nome dell’evento? La descrizione del plugin mostra testo con eventi, ma non come questo sia stato effettivamente impostato.
2. Come si creano eventi ricorrenti?
3. Il calendario delle festività mostra colori. Anche il calendario normale può avere colori e, in caso affermativo, come?
4. La funzionalità separata “eventi” può apparentemente produrre un feed ical. Può farlo un calendario “di base”?

Altre domande sul calendario delle festività

Utilizza la stessa sintassi del calendario per argomento o quella “evento”? È limitato alle “ferie dello staff” o potrebbe essere utilizzato da chiunque possa rispondere a un dato argomento? Da dove provengono i colori? L’emoji “Holiday flair” è modificabile? È possibile renderla visibile a chiunque, o a un gruppo arbitrario, non solo allo staff?

Ecc. …

Alcune di queste cose le ho capite da solo o chiedendo supporto. Ma devono davvero essere documentate nel post del plugin.

Sarebbe probabilmente utile anche spiegare alcune delle limitazioni — la data di inizio settimana non segue la tua locale e non è configurabile, l’intera cosa è confusa riguardo ai fusi orari… e se c’è una roadmap o piani per affrontare alcune di queste cose o aggiungere nuove funzionalità (o se non ci sono!), per favore dillo anche quello.

Grazie! Questa è una piccola funzionalità carina di Discourse che potrebbe essere molto utile a molte persone, ma è anche piuttosto confusa.

[nathank (Nathan Kershaw)]

Quel post è una wiki, quindi puoi contribuire tu stesso facilmente. Sarebbe molto utile per tutti.

[mattdm (Matthew Miller)]

Posso, anche se alcune cose saranno solo congetture!

[JammyDodger]

Ho notato questo in Argomenti Correlati mentre stavo aggiornando gli argomenti Calendario ed Evento (un’altra vittoria per Argomenti Correlati ).

Ho appena riorganizzato in modo che entrambe le funzionalità appaiano correttamente come un unico argomento plugin, il che dovrebbe, si spera, rimuovere un po’ di confusione:

Discourse Calendar (and Event)

Summary Discourse Calendar and Event adds dynamic and interactive calendar and event features to your Discourse site. Install Guide This plugin is bundled with Discourse core. There is no need to install the plugin separately. Enabling Calendar (and Event) The Calendar plugin can be enabled either by the toggle or from its settings, both accessible from your admin/plugins page: [/admin/plugins] Features Somewhat unsurprisingly, Discourse Calendar …

Ho anche suddiviso molti dettagli su “come fare” in un paio di guide per dare loro un po’ di respiro:

Creating and managing calendars

This guide explains how to create and manage calendars in Discourse using the Calendar (and Event) plugin. Required user level: All users Calendars are a powerful feature in Discourse that allow you to organize and display events within your community. This guide will walk you through the process of creating calendars, adding events, and managing them effectively. Summary Enable the Calendar plugin Create a calendar in a topic or category Add events to you…

Creating and managing events

This guide explains how to create and manage events using the Calendar (and Event) plugin in Discourse. It covers how to create events, set event options, interact with events, and view the upcoming events calendar. Required user level: All users (with appropriate permissions) Enabling events Events are a feature of the Calendar (and Event) plugin. To use this feature: Enable the Calendar (and Event) plugin Configure related settings For detailed instruct…

L’obiettivo principale era dare loro una struttura più coerente (anche se ho aggiunto un rapido aggiornamento per buona misura). Sono stati un po’ spinosi da sistemare, ma penso che siano in una forma migliore di prima. Avendo dormito su questo, penso che ci siano alcune cose che vorrei ancora fare, quindi non userò ancora il .

Ma si spera che ci stiamo muovendo nella giusta direzione.