docs

Author: bketelsen

docs/README.md

@@ -0,0 +1,30 @@
+# Show Runner   
+
+Show Runner is a management platform for physical and virtual conferences.  It consists of modules that provide the following functionality:
+
+- Ticket Management and Sales
+- Conference Management
+- Public Website
+
+## Terms and Definitions
+
+Conference
+: A one-time event or series of events grouped under a common name.  e.g. GopherCon
+
+Event
+: A single event, a scheduled instance of a Conference. e.g. GopherCon 2020
+
+Attendee
+: A person who holds a ticket for an Event
+
+Sponsor
+: A company that has purchased a sponsorship for an Event
+
+## Overview
+
+Show Runner will consist of two core components:
+
+* API
+* Administration website
+
+Show Runner will expose information about Conference, Event, Sponsors, and more through a read-only public API which will be consumed by a public-facing marketing website.

docs/attendee.md

@@ -0,0 +1,20 @@
+# Attendee
+
+An attendee is a person who participates in an [event]() either virtually or in person.
+
+## Attributes
+Attendees may have the following attributes:  
+
+* Name 
+* Address
+* Phone Number
+* ...
+
+## Actions
+An attendee may perform the following actions:
+
+* View Tickets
+* Modify profile
+* Transfer ticket
+* ...
+

docs/conference.md

@@ -0,0 +1,12 @@
+# Conference
+
+A conference is a named series of [events]().  Gophercon is a conference.  Gophercon 2020 is an Event
+
+## Attributes
+Conference may have the following attributes:  
+
+* Name 
+* ...
+
+## Actions
+

docs/event.md

@@ -0,0 +1,23 @@
+# Event
+
+An event is an instance of a [conference]().  GopherCon 2020 is an event.
+
+## Attributes
+Conference may have the following attributes:  
+
+* Name 
+* Start Date
+* End Date
+* Live (true/false) // event is ready for public sales
+* Time Zone
+* Description
+* Contact Email
+* twitter account and hashtag // maybe abstract into Social Media interface?
+* Venue Name
+* Venue Address
+
+*
+
+
+## Actions
+

docs/sponsor.md

@@ -0,0 +1,25 @@
+# Sponsor
+
+A sponsor is a company that pays the [conference]() a fee in consideration for marketing based on sponsorship [level]().
+
+## Attributes
+Sponsors may have the following attributes
+
+* Company Name 
+* Address
+* Phone Number
+* Marketing Contact ...
+* HR/Recruiting Contact ...
+* Logistics Contact ...
+* Sponsorship Level
+* Various logos, banners, etc. TBD
+* Public profile // for display on website
+
+## Actions
+A sponsor may perform the following actions
+
+* Modify Contact
+* Modify public profile
+* Download opt-in Email list
+* Upload media (logos, banners)
+