From 622acfab533f3dcab7a03efe1511c146baf755cf Mon Sep 17 00:00:00 2001 From: Andy McKay Date: Wed, 8 Apr 2015 17:00:42 -0700 Subject: [PATCH] initial fixes for #12 --- docs/design/overview.rst | 42 ++++++++++++++++++++++++++++++++++++++++ docs/design/ux.rst | 2 ++ docs/index.rst | 1 + 3 files changed, 45 insertions(+) create mode 100644 docs/design/overview.rst diff --git a/docs/design/overview.rst b/docs/design/overview.rst new file mode 100644 index 0000000..e42d29d --- /dev/null +++ b/docs/design/overview.rst @@ -0,0 +1,42 @@ +Overview +-------- + +Front end components +==================== + +There would be at least three main front end components. + +Library ++++++++ + +Added to the site selling the product. The library allows the selling site to +easily bring up the iframe for completing the payment flow and then processing +the completed flow. + +* *UX*: none +* *Documentation*: ... +* *Repository*: ... +* *Uptime*: will be hosted on the site selling the product. + +Buy flow +++++++++ + +Shown in an iframe to the end user. Triggered by the library. + +* *UX*: :ref:`buy flow ` +* *Documentation*: ... +* *Repository*: ... +* *Uptime*: very high, if this goes out, purchasing will fail. Based also upon + the uptime of the payment provider and all the stacks inbetween. + +Management screens +++++++++++++++++++ + +Shown as a standard set of pages. Accessible at a URL and linked from the +Firefox Accounts profile page. + +* *UX*: ... +* *Documentation*: ... +* *Repository*: +* *Uptime* :high, this doesn't stop purchasing work but prevents later + management. diff --git a/docs/design/ux.rst b/docs/design/ux.rst index 85a6244..e482ca2 100644 --- a/docs/design/ux.rst +++ b/docs/design/ux.rst @@ -5,6 +5,8 @@ User experience documentation. Status: **in draft** expect changes. +.. _purchase-label: + Purchase flow ------------- diff --git a/docs/index.rst b/docs/index.rst index da0238b..5627e58 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ Contents: :maxdepth: 2 contributing.rst + design/overview.rst design/api.rst design/design.rst design/ux.rst