diff --git a/docs/index.rst b/docs/index.rst index 45faa102..46a43cff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ Apps: conference sponsorship + speakers Indices and tables diff --git a/docs/speakers.rst b/docs/speakers.rst new file mode 100644 index 00000000..affaa198 --- /dev/null +++ b/docs/speakers.rst @@ -0,0 +1,22 @@ +Speaker App +=========== + +The ``speaker`` app allows speakers to set up their profile, prior to or as +part of the proposal submission phase. The **dashboard** is the means through +which speakers manage their own profiles. + +We are planning to make the Speaker model more pluggable so, if you have +particular fields you'd like your speakers to fill out, you'll be able to +customize things more easily. + +Additional Speakers +------------------- + +Because ``symposion`` supports additional speakers being attached to a +proposal or actual presentation, it has the notion of a ``Speaker`` that is +not yet a ``User`` on the site. For this reason, a ``Speaker`` may have a +NULL ``user`` field (hopefully temporarily) as well as an ``invite_email`` +and ``invite_token`` field for the invitation sent to the additional speaker +to join. + +.. todo:: perhaps explain the invitation flow diff --git a/requirements/docs.txt b/requirements/docs.txt index 82750ff4..366ee161 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,3 +1,3 @@ # requirements needed to build the docs -Sphinx==1.1.2 +Sphinx==1.1.3