discourse/plugins/discourse-calendar
David Taylor 6081bc2249
DEV: Standardize Ember route, controller and template naming (#34417)
For historical reasons, Discourse has a customized Ember resolver. This
had a much more fuzzy implementation of 'normalize' and 'findTemplate'
functions. This leniency meant that our file naming hasn't always
matched Ember conventions.

Standardizing our naming will make things easier to understand for
developers, and will make adoption of newer ecosystem tooling easier
(e.g. route-based bundle splitting in Embroider/vite)

This commit adds deprecations to the resolver when this leniency is
used, and uses a fully bespoke codemod to rename all of the affected
routes/controllers/templates in the Discourse core repository.
Backwards-compatibility is maintained for anyone looking up the old
names in the resolver.
2025-09-25 11:27:45 +01:00
..
app PERF: correctly index event dates (#34877) 2025-09-19 17:41:57 +02:00
assets DEV: Standardize Ember route, controller and template naming (#34417) 2025-09-25 11:27:45 +01:00
config Update translations (#34839) 2025-09-24 14:48:18 +02:00
db/migrate PERF: correctly index event dates (#34877) 2025-09-19 17:41:57 +02:00
jobs DEV: rename topic_id to timerable_id for BaseTimer (#34667) 2025-09-17 13:19:17 +08:00
lib PERF: correctly index event dates (#34877) 2025-09-19 17:41:57 +02:00
spec FIX: disable category calendar when post event are disabled (#34897) 2025-09-22 17:05:19 +02:00
test/javascripts UX: Use admin table classes for Calendar Holidays list (#34942) 2025-09-24 17:13:50 +10:00
vendor/holidays CHORE: Import holiday definition updates. (#34835) 2025-09-17 16:07:06 +10:00
.prettierignore
plugin.rb DEV: Clean up requires (#34946) 2025-09-24 12:00:22 +02:00
README.md

Discourse Calendar

Adds the ability to create a dynamic calendar in the first post of a topic.

Topic discussing the plugin itself can be found here: https://meta.discourse.org/t/discourse-calendar/97376

Customization

Events

  • discourse_post_event_event_will_start this DiscourseEvent will be triggered one hour before an event starts
  • discourse_post_event_event_started this DiscourseEvent will be triggered when an event starts
  • discourse_post_event_event_ended this DiscourseEvent will be triggered when an event ends

Custom Fields

Custom fields can be set in plugin settings. Once added a new form will appear on event UI. These custom fields are available when a plugin event is triggered.

Holidays

See an incorrect or missing holiday? Familiarize yourself with the holiday definition Syntax. Then make your updates in the vendor/holiday/definitions directory.

Generate updated holidays as follows.

cd vendor/holidays

# Generate holiday definitions
rake generate:definitions

Install the plugin and switch to the discourse root(not the plugin directory).

# Collect all holiday regions into assets/javascripts/lib/regions.js
bin/rails javascript:update_constants

Interactions with Other Plugins

You can use an element of this plugin with the Right Sidebar Blocks component. You'll want to ensure the desired route is enabled via the events calendar categories setting. In Right Sidebar Block's settings, the block name will be upcoming-events-list, and the params use this syntax, for example MMMM D, YYYY.