summaryrefslogtreecommitdiff
path: root/design-documents
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2021-11-29 03:36:02 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2021-11-29 03:36:02 -0500
commitdccfbcca392bf461ceb0587331cff2e3e21f197d (patch)
tree7edfcabc04be478491dba41df23aed6c8913d0fb /design-documents
parentf4a3d6c9fe8255fd0080c16ad9559a32d74c8402 (diff)
downloaddocs-dccfbcca392bf461ceb0587331cff2e3e21f197d.tar.gz
docs-dccfbcca392bf461ceb0587331cff2e3e21f197d.tar.bz2
docs-dccfbcca392bf461ceb0587331cff2e3e21f197d.zip
fix grammar: s/a/an/
Diffstat (limited to 'design-documents')
-rw-r--r--design-documents/002-wallet-exchange-management.rst2
-rw-r--r--design-documents/015-merchant-backoffice-routing.rst25
-rw-r--r--design-documents/016-backoffice-order-management.rst2
-rw-r--r--design-documents/023-taler-kyc.rst2
4 files changed, 14 insertions, 17 deletions
diff --git a/design-documents/002-wallet-exchange-management.rst b/design-documents/002-wallet-exchange-management.rst
index 9d10045a..18015916 100644
--- a/design-documents/002-wallet-exchange-management.rst
+++ b/design-documents/002-wallet-exchange-management.rst
@@ -40,7 +40,7 @@ audited by a trusted auditor.
An exchange might only be known the wallet temporarily. For example,
the wallet UI may allow the user to review the fee structure of an
exchange before the wallet is permanently added to the wallet.
-Once a an exchange is either (a) marked as trusted or (b) used for a
+Once an exchange is either (a) marked as trusted or (b) used for a
withdrawal operation, it is marked as permanent.
Exchanges that are not permanent will be automatically be removed
diff --git a/design-documents/015-merchant-backoffice-routing.rst b/design-documents/015-merchant-backoffice-routing.rst
index f6372dcc..7362642e 100644
--- a/design-documents/015-merchant-backoffice-routing.rst
+++ b/design-documents/015-merchant-backoffice-routing.rst
@@ -6,16 +6,16 @@ Motivation
==========
A well defined routing will allow users to share backoffice links pointing
-directly into instance pages (settings, orders, products, etc...)
+directly into instance pages (settings, orders, products, etc...)
-The backoffice should load from the instance URL and then allow a internal
+The backoffice should load from the instance URL and then allow an internal
routing of the views with the possibility to accessing them directly when
sharing a link.
This 3 definitions are going to be use in this document:
-* BACKOFFICE_URL as the url where the app is loaded.
-
+* BACKOFFICE_URL as the url where the app is loaded.
+
* BACKEND_URL as the url where the merchant backend is.
* INSTANCE the name of the instance being manage
@@ -27,13 +27,13 @@ Application Ready definition
The application is considered ready after
* the user tried to login.
-
+
* the application checked that the backend url points to a merchant backend
* the merchant backend response successfully
The backoffice test for ``$BACKEND_URL/config`` to define if the $BACKEND_URL is ok.
-The application can potentially test if the protocol or version matched.
+The application can potentially test if the protocol or version matched.
While the application is not ready, just the top navigation bar will be shown
with a message in the left and the lang selection option.
@@ -58,7 +58,7 @@ Knowing that the $BACKEND_URL points to a correct merchant backend the SPA will
check for ``$BACKEND_URL/management/instances``:
* if Unauthorized ask for credentials
-
+
* if error check with the user
* if not found, then url should end with ``/instances/$INSTANCE``. otherwise is
@@ -69,11 +69,11 @@ check for ``$BACKEND_URL/management/instances``:
When a user access the SPA there are 3 scenarios possible:
* **standard**: admin is false so BACKEND_URL points to a non-default instance.
- standard features and links are shown
+ standard features and links are shown
* **admin**: admin is true so BACKEND_URL point to default instance. same as
before and user can create and list instances with some additional links in
- the sidebar.
+ the sidebar.
* **mimic**: admin is true and the request parameter "instance" is set $INSTANCE
instance. BACKEND_URL point to default instance but the user is managing
@@ -99,7 +99,7 @@ parameter (like order id or product id) it should be accessible from the Sidebar
If the user has admin access, this entry points are available:
- /instances: Show the list of instances currently created
- - /instance/new: Show a instance creation form
+ - /instance/new: Show an instance creation form
Where admin or not, there is also this entry points:
@@ -145,7 +145,7 @@ credentials or the backend url
Not found
---------
-For any case that the backend respond 404 the application will render a
+For any case that the backend respond 404 the application will render a
custom not found page
Default instance is missing
@@ -155,6 +155,3 @@ If the **user is admin** AND is loading the setting page (/update), product list
(/products), order list (/orders) or transfer list (/transfers) AND **gets a
404** it will tell the user that it need to create a default instance before
proceeding.
-
-
-
diff --git a/design-documents/016-backoffice-order-management.rst b/design-documents/016-backoffice-order-management.rst
index 00250cd2..ff8fb645 100644
--- a/design-documents/016-backoffice-order-management.rst
+++ b/design-documents/016-backoffice-order-management.rst
@@ -35,7 +35,7 @@ Listing orders
.. image:: ../backoffice-order-list.svg
:width: 800
-4 tabs will be show for a easy access to common filter, click on any of this and
+4 tabs will be show for an easy access to common filter, click on any of this and
search will reset all filter except date
* paid (default)
diff --git a/design-documents/023-taler-kyc.rst b/design-documents/023-taler-kyc.rst
index c3c11f02..b7349bfc 100644
--- a/design-documents/023-taler-kyc.rst
+++ b/design-documents/023-taler-kyc.rst
@@ -88,7 +88,7 @@ has the KYC status set to positive (unless KYC is disabled in the exchange
configuration).
To allow the wallet to do the KYC check if it is about to exceed a set balance
-threshold, we modify the ``/keys`` response to add a optional field
+threshold, we modify the ``/keys`` response to add an optional field
``wallet_balance_limit_without_kyc`` the wallet is allowed to hold in coins
from this exchange without KYC. If this field is absent, there is no limit.
If the field is provided, a correct wallet must create a long-term