[taler-docs] branch master updated (db383fd -> dcd0deb)

[gnunet]

This is an automated email from the git hooks/post-receive script.

ttn pushed a change to branch master
in repository docs.

    from db383fd  purge docs of ‘gnunet-ecc’
     new 6a2dc8a  fix typo: s/Setting up the Sandbox/Configuring the Sandbox/
     new 9feddcf  fix typo: don't include ‘$’ in ‘PATH’ reference
     new 464f3ab  say "environment" variable when referring to ‘PATH’
     new 04df3fd  diction: say " and " instead of "+"
     new 40fd969  fix typo: s/command line/command-line/
     new 08993d3  add leading "$" to ‘code-block console’ command
     new 083b0c9  add comment/question re ‘libeufin-cli sandbox check’
     new 81d41b9  use ``, not ", to mark up ‘testacct01’
     new 7f63796  use ``, not *, to mark up ‘bankaccount’
     new 11a2d52  add :ref: to ‘Sandbox API’
     new 507c586  add backslash+LF to ‘code-block console’ commands (three 
instances)
     new c0bc6a6  expand from "step (2)" to "the previous step (etc)"
     new 88600da  simplify sentence a bit
     new 5a8cc0d  remove spurious "(4)"
     new c014740  be explicit: say "bank's keys"
     new a28c97e  add comma
     new c526049  fix typo: add "has"
     new 4586e7c  say "cron(8)" instead of simply "cron"
     new 5f3a8df  delete spurious "to"
     new 96722d1  answer question
     new dcd0deb  change command name

The 21 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 libeufin/nexus-tutorial.rst | 48 ++++++++++++++++++++++++++-------------------
 1 file changed, 28 insertions(+), 20 deletions(-)

diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
index c00b9d4..ff8d53e 100644
--- a/libeufin/nexus-tutorial.rst
+++ b/libeufin/nexus-tutorial.rst
@@ -13,7 +13,7 @@ via the EBICS protocol.
 
 In order to follow all the steps below, the reader should either
 have access to a bank account with EBICS support or follow the
-steps in "Setting up the Sandbox".
+steps in "Configuring the Sandbox".
 
 
 Installing LibEuFin
@@ -58,8 +58,8 @@ Pre-built packages can be obtained from the `taler.net website
 <https://taler.net/files/libeufin>`__.
 
 Unpack the ``libeufin-$version.zip`` file to
-your desired location (typically ``/opt`` or ``~/opt``) and make sure that 
your ``$PATH``
-variable contains the ``bin/`` directory of the unpacked archive.
+your desired location (typically ``/opt`` or ``~/opt``) and make sure that 
your ``PATH``
+environment variable contains the ``bin/`` directory of the unpacked archive.
 
 Building from source
 --------------------
@@ -70,7 +70,7 @@ Nexus belongs to the LibEuFin project, and can be downloaded 
via Git:
 
   $ git clone git://git.taler.net/libeufin
 
-Note that Kotlin+Gradle should already work on the host system.
+Note that Kotlin and Gradle should already work on the host system.
 
 Navigate into the *libeufin* local repository, and from top-level run:
 
@@ -109,16 +109,20 @@ The sandbox service is started with the following command:
 To reset the state of the sandbox, delete the database.  By default,
 the database is a SQLite3 file in ``/tmp/libeufin-sandbox.sqlite3``.
 
-For invocations of the LibEuFin command line interface tool (``libeufin-cli``),
+For invocations of the LibEuFin command-line interface tool (``libeufin-cli``),
 the following environment variable must be set to the URL of the sandbox
 service:
 
 .. code-block:: console
 
-   export LIBEUFIN_SANDBOX_URL=http://localhost:5000/
+   $ export LIBEUFIN_SANDBOX_URL=http://localhost:5000/
 
 Verify that the sandbox is running:
 
+.. ??? What is the expected output of this command?
+.. => it's a JSON fragment like {name: "libeufin-sandbox", version: "0.0.0"}
+   Basically, it calls this: 
https://git.taler.net/libeufin.git/tree/sandbox/src/main/kotlin/tech/libeufin/sandbox/Main.kt#n288
+ 
 .. code-block:: console
 
    $ libeufin-cli sandbox check
@@ -153,12 +157,12 @@ Create a bank account for the subscriber and add a sample 
transaction:
        --ebics-user-id user01 \
        --ebics-partner-id partner01
 
-The account name "testacct01" is the unique identifier of the account within
+The account name ``testacct01`` is the unique identifier of the account within
 the sandbox.  The EBICS parameters identify the subscriber that should have
 access to the bank account via EBICS.
 
 To populate the account with some test transactions, run the following command
-(note that we use the *bankaccount* subcommand, because there is no need to 
rely
+(note that we use the ``bankaccount`` subcommand, because there is no need to 
rely
 on EBICS):
 
 .. code-block:: console
@@ -177,7 +181,8 @@ Payments to a sandbox bank account can be listed as follows:
 
    For more information on the available commands, use the built-in ``--help`` 
flag.
 
-   The full functionality of the sandbox is available via the API. 
(FIXME(TTN): specify which API)
+   The full functionality of the sandbox is available via
+   the :ref:`Sandbox API <sandbox-api>`.
 
 
 Connect Nexus with an EBICS account
@@ -210,13 +215,16 @@ For example:
 
 .. code-block:: console
 
-  $ libeufin-nexus serve 
--db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
+  $ libeufin-nexus serve \
+      
--db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
 
 At this point a superuser account needs to be created:
 
 .. code-block:: console
 
-  $ libeufin-nexus superuser 
--db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
 foo # Will interactively ask for password
+  $ libeufin-nexus superuser \
+      
--db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
 \
+      foo # Will interactively ask for password
 
 For simplicity, a superuser can as well act as a normal user, but an API
 to create less privileged users is offered.
@@ -230,7 +238,7 @@ The command line interface needs the following three values
 to be defined in the environment: ``LIBEUFIN_NEXUS_URL``, 
``LIBEUFIN_NEXUS_USERNAME``,
 and ``LIBEUFIN_NEXUS_PASSWORD``.  In this example, ``LIBEUFIN_NEXUS_USERNAME`` 
should be
 set to ``foo``, and ``LIBEUFIN_NEXUS_PASSWORD`` to the value given for its 
password
-in step (2).
+in the previous step (with the ``libeufin-nexus superuser`` command).
 
 Next, we create a EBICS *bank connection* that nexus can use to communicate 
with the bank.
 
@@ -250,9 +258,9 @@ Next, we create a EBICS *bank connection* that nexus can 
use to communicate with
           --ebics-user-id $EBICS_USER_ID \
           $CONNECTION_NAME
 
-If the step above executed correctly, Nexus created all the cryptographic
+If this step executes correctly, Nexus will have created all the cryptographic
 material that is needed on the client side; in this EBICS example, it created
-the signature and identification keys.  It is therefore advisable to *(4) make
+the signature and identification keys.  It is therefore advisable to *make
 a backup copy* of such keys.
 
 .. code-block:: console
@@ -265,8 +273,8 @@ a backup copy* of such keys.
           $CONNECTION_NAME
 
 At this point, Nexus needs to both communicate its keys to the bank, and
-download the bank's.  This syncronization happens through the INI, HIA, and
-finally HPB message types.
+download the bank's keys.  This syncronization happens through the INI, HIA, 
and
+finally, HPB message types.
 
 After the electronic synchronization, the subscriber must confirm their keys
 by sending a physical mail to the bank.  The following command helps generating
@@ -285,7 +293,7 @@ such letter:
 
   $ libeufin-cli \
       connections \
-        sync \
+        connect \
           $CONNECTION_NAME
 
 Once the connection is synchronized, Nexus needs to import locally the data
@@ -346,7 +354,7 @@ through the bank connection:
    and the type of transactions to fetch (inter-day statements or intra-day
    reports).
 
-Once Nexus stored all the information in the database, the
+Once Nexus has stored all the information in the database, the
 client can ask to actually see the transactions:
 
 .. code-block:: console
@@ -394,7 +402,7 @@ With an EBICS bank connection, the LibEuFin nexus needs to 
regularly query for
 new transactions and (re-)submit prepared payments.
 
 It is possible to schedule these tasks via an external task scheduler such as
-cron.  However, the nexus also has an internal task scheduling mechanism for
+cron(8).  However, the nexus also has an internal task scheduling mechanism for
 accounts.
 
 
@@ -466,7 +474,7 @@ existing bank account / connection pair.
 
 At this point, the additional *taler-wire-gateway* (FIXME: link
 here to API here) API becomes offered by the Nexus.  The purpose
-is to let a Taler exchange to rely on Nexus to manage its bank account.
+is to let a Taler exchange rely on Nexus to manage its bank account.
 
 
 Managing Permissions and Users

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.