Skip to content

Commit f18ed12

Browse files
committed
Refined Events docs
1 parent 095b63b commit f18ed12

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

  • client/documentation/admin-dashboard
Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# Events
22

3+
Event instances that are displayed on the landing and events pages
4+
35
## Fields
46

5-
**Name:** Required field for the event's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters.
7+
**Name:** Required character field for the event's name.
68

79
**Date:** Required field for the event date and time. Must be a valid date and time. Uses either ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) or American format (MM-DD-YYYY HH:MM) for date and time representation.
810

9-
**Description:** Optional field for a description of the event. A character field of maximum length 256 characters.
11+
**Description:** Optional character field for a description of the event.
12+
13+
**Publication Date:** Required field for the date the event is published. Uses either ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) or American format (MM-DD-YYYY HH:MM) for date and time representation.
14+
15+
**Cover Image:** Optional field to upload a cover image for the event, which will otherwise display the event's name.
1016

11-
**Publication Date:** Required field for the date the event is published. Must be a valid date (DD/MM/YYYY). Uses either ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) or American format (MM-DD-YYYY HH:MM) for date and time representation.
17+
**Location:** Required field for the event location.
1218

13-
**Cover Image:** Optional field to upload a cover image for the event. Must be an image file. If no cover image is provided, a default club logo will be displayed instead.
19+
## Other Notes
1420

15-
**Location:** Required field for the event location. A character field of maximum length 256 characters.
21+
An Event object can referenced in a Game object's 'Event' field, which is also a foreign key. On the events page, events will either show up under past or upcoming depending on their date, and each Event object can be directly routed to at /events/{id} (integer uid).

0 commit comments

Comments
 (0)