add in some docs about the export (bug 873191)

Andy McKay · Andy McKay · commit a1f02c94a60a · 2013-05-27T10:05:27.000-07:00
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -16,16 +16,17 @@ This documentation covers interacting with the `Firefox Marketplace`_.
 
    topics/overview.rst
    topics/authentication.rst
+   topics/abuse.rst
    topics/accounts.rst
    topics/apps.rst
-   topics/submission.rst
+   topics/export.rst
+   topics/home.rst
    topics/payment.rst
-   topics/search.rst
    topics/ratings.rst
-   topics/home.rst
-   topics/abuse.rst
    topics/reviewers.rst
+   topics/search.rst
    topics/site.rst
+   topics/submission.rst
 
 
 Quickstart
diff --git a/docs/api/topics/export.rst b/docs/api/topics/export.rst
@@ -0,0 +1,28 @@
+.. _export:
+
+======
+Export
+======
+
+There is an export of nightly data that is available as a tarball. The download
+can be found at the following URLs:
+
+* Development server: https://marketplace-dev-cdn.allizom.org/dumped-apps/tarballs/YYYY-MM-DD.tgz
+
+Contents:
+
+* *readme.txt* and *license.txt*: information about the export.
+
+* *apps*: this directory contains all the exported apps. Each app is a seperate
+  JSON file and contains the output of :ref:`the app GET method <app-response-label>`
+
+Caveats:
+
+* An app must be public to be exported, which means apps may be removed as
+  their status on the marketplace changes.
+
+* No user object is present, so user specific information about the app is not
+  present.
+
+* The export has no locale, region or carrier specified. It defaults to the
+  region ``worldwide`` and locale ``en-US``.
