Skip to content

Commit 4c8d7fb

Browse files
Issue 93 events documentation (#152)
merges events documentation into main
1 parent 2c6ccd5 commit 4c8d7fb

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

  • client/documentation/admin-dashboard
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Events
2+
3+
URL: `/admin/game_dev/event/add`
4+
5+
Event instances that are displayed on the landing and events pages
6+
7+
## Fields
8+
9+
**Name:** Required character field for the event's name.
10+
11+
**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.
12+
13+
**Description:** Optional character field for a description of the event.
14+
15+
**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.
16+
17+
**Cover Image:** Optional field to upload a cover image for the event, which will otherwise display the event's name.
18+
19+
**Location:** Required field for the event location.
20+
21+
## Other Notes
22+
23+
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)