зеркало из https://github.com/mozilla/payments.git
Add travis to make sure docs build and links work
This commit is contained in:
Родитель
9bcd364b52
Коммит
affc34fd69
|
@ -0,0 +1,13 @@
|
|||
language: python
|
||||
python:
|
||||
- "2.7"
|
||||
sudo: false
|
||||
install:
|
||||
- pip install -r requirements/docs.txt
|
||||
script: make -C docs/ html linkcheck
|
||||
notifications:
|
||||
irc:
|
||||
channels:
|
||||
- "irc.mozilla.org#amo-bots"
|
||||
on_success: change
|
||||
on_failure: always
|
|
@ -1,11 +1,13 @@
|
|||
Backend API
|
||||
-----------
|
||||
|
||||
The payments-ui interacts with payments-service,
|
||||
its `API docs <https://payments-service.readthedocs.org/en/latest/>`_ provide
|
||||
details on how to complete all the tasks needed to complete a payment.
|
||||
The payments-ui interacts with
|
||||
the `payments-service <https://payments-service.readthedocs.org/en/latest/>`_ API
|
||||
to handle transactions and perform management functions.
|
||||
|
||||
Payments-service provides the authentication layer around solitude. The
|
||||
`API docs <https://solitude.readthedocs.org/en/latest/>`_ for solitude shows
|
||||
how to interact with the
|
||||
`payment provider <https://solitude.readthedocs.org/en/latest/topics/braintree.html>`_.
|
||||
Payments-service provides the authentication layer around
|
||||
`Solitude <https://solitude.readthedocs.org/en/latest/>`_.
|
||||
|
||||
See the
|
||||
`Solitude Braintree docs <https://solitude.readthedocs.org/en/latest/topics/braintree.html>`_
|
||||
for information about the payment gateway.
|
||||
|
|
|
@ -71,7 +71,7 @@ no particular order:
|
|||
Why not the drop-in UI?
|
||||
+++++++++++++++++++++++
|
||||
|
||||
Braintree provides a `drop-in UI <https://developers.braintreepayments.com/guides/drop-in>`_.
|
||||
Braintree provides a `drop-in UI <https://developers.braintreepayments.com/ios+ruby/guides/drop-in>`_.
|
||||
Why not use that?
|
||||
|
||||
* At the moment Braintree doesn't support localisations. "Language support for
|
||||
|
@ -168,7 +168,7 @@ Solitude
|
|||
Stores a limited amount of payment information and interacts with the payment
|
||||
provider.
|
||||
|
||||
* *Documentation*: `solitude docs <https://solitude.readthedocs.org>`_
|
||||
* *Documentation*: `solitude docs <https://solitude.readthedocs.org/en/latest/>`_
|
||||
* *Repository*: https://github.com/mozilla/solitude
|
||||
* *Uptime requirements*: very high.
|
||||
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
====================================
|
||||
Payments for Firefox Accounts
|
||||
====================================
|
||||
|
||||
|
@ -31,6 +32,26 @@ Other:
|
|||
* `Public wiki page <https://wiki.mozilla.org/CloudServices/Payments>`_
|
||||
* `Public mailing list <https://mail.mozilla.org/listinfo/dev-payments>`_
|
||||
|
||||
Contributing to this document
|
||||
=============================
|
||||
|
||||
If you are editing this documentation, you need to set yourself up to build the
|
||||
docs as you make changes. Using Python and `pip <https://pip.pypa.io/en/stable/>`_,
|
||||
install the dependencies from a shell
|
||||
(you may wish to install them in a `virtualenv <https://pip.pypa.io/en/stable/>`_)::
|
||||
|
||||
pip install -r requirements/docs.txt
|
||||
|
||||
Build the documentation::
|
||||
|
||||
make -C docs/ html
|
||||
|
||||
Open ``docs/_build/html/index.html`` in your web browser.
|
||||
|
||||
You can also check for broken links like this::
|
||||
|
||||
make -C docs/ linkcheck
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
|
|
@ -128,17 +128,15 @@ A webhook is an event sent by Braintree to certain events.
|
|||
Configuring braintree
|
||||
+++++++++++++++++++++
|
||||
|
||||
When you are using the sandbox go to Settings > Webhooks. Add in your server,
|
||||
for example::
|
||||
|
||||
http://pay.dev.mozaws.net:8000/api/braintree/webhook/
|
||||
When you are using the sandbox go to Settings > Webhooks. Add in your server.
|
||||
For example: ``http://pay.dev.mozaws.net:8000/api/braintree/webhook/``
|
||||
|
||||
You can select all "notifications to send" or just pick the ones we actually
|
||||
process which are: Subscription Canceled, Subscription Charged Successfully
|
||||
and Subscription Charged Unsuccessfully.
|
||||
|
||||
If you are doing local development, you might need to expose your local server
|
||||
publicly. Something like `ngrok <http://ngrok.com>`_ can do this easily by
|
||||
publicly. Something like `ngrok <https://ngrok.com>`_ can do this easily by
|
||||
entering::
|
||||
|
||||
ngrok pay.dev:8000
|
||||
|
@ -154,8 +152,8 @@ end-to-end testing with Braintree. In all cases, Braintree is right and this
|
|||
tool is wrong.
|
||||
|
||||
.. note:: To use this tool, the solitude container needs to make a request to the
|
||||
payments-service server, usually this means http://pay.dev:8000/, you might need
|
||||
to use an IP address if that doesn't resolve.
|
||||
payments-service server, usually this means ``http://pay.dev:8000/``,
|
||||
you might need to use an IP address if that doesn't resolve.
|
||||
|
||||
Inside the solitude container run::
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче