From 7653b8cdeecd79ff38adf310ee9042190288999d Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Mon, 24 Feb 2020 14:22:41 +0100 Subject: add links to buildbot and lcov results to docs page --- icons/buildbot.svg | 13 ++ template/developers.html.j2 | 300 -------------------------------------------- template/docs.html.j2 | 16 +++ 3 files changed, 29 insertions(+), 300 deletions(-) create mode 100644 icons/buildbot.svg delete mode 100644 template/developers.html.j2 diff --git a/icons/buildbot.svg b/icons/buildbot.svg new file mode 100644 index 00000000..23ae6c0e --- /dev/null +++ b/icons/buildbot.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/template/developers.html.j2 b/template/developers.html.j2 deleted file mode 100644 index 0a52128b..00000000 --- a/template/developers.html.j2 +++ /dev/null @@ -1,300 +0,0 @@ -{% extends "common/base.j2" %} -{% block body_content %} -
-
-

{{ _("Taler for developers") }}

-
-
- -
-
-
-

{{ _("Free") }}

- -

- {% trans %} - GNU Taler is free software implementing an open - protocol. Anybody is welcome to integrate our reference - implementation into their applications. Different - components of Taler are being made available under - different licenses. The Affero GPLv3+ is used for the - exchange, the LGPLv3+ is used for reference code - demonstrating integration with merchant platforms, and - licenses like GPLv3+ are used for - wallets and related customer-facing software. We are - open for constructive suggestions for maximizing the - adoption of this payment platform. - {% endtrans %} -

- -
-
-

{{ _("RESTful") }}

- -

- {% trans %} - Taler is designed to work on the Internet. To - ensure that Taler payments can work with - restrictive network setups, Taler uses a RESTful - protocol over HTTP or HTTPS. Taler's security does - not depend upon the use of HTTPS, but obviously - merchants may choose to offer HTTPS for consistency - and because it generally is better for privacy - compared to HTTP. Taler uses JSON to encode - structure data, making it easy to integrate Taler - with existing Web applications. Taler's protocol - is documented in detail at - {% endtrans %} - docs.taler.net. -

-
-
-
- -
-
-
-
-

{{ _("Code") }}

- -

- {% trans %} - Taler is currently primarily developed by a - research team at - {% endtrans %} - Inria - {% trans %} - and - {% endtrans %} - GNUnet. - {% trans %} - However, contributions from anyone are welcome. Our Git - repositories can be cloned using the Git and HTTP access methods - against git.taler.net with the name of the respective - repository. A list of repositories can be found in our - {% endtrans %} - GitWeb. -

-
-
-

{{ _("Documentation") }}

- -

- {% trans %} - In addition to this website, the - {% endtrans %} - {{ _("documented code")}} - {% trans %} - and the - {% endtrans %} - {{ _("API documentation")}}. - {% trans %} - Technical papers can be found in our - {% endtrans %} - {{ _("bibliography")}}. -

-
-
-

{{ _("Discussion") }}

- -

- {% trans %} - We have a mailing list for developer discussions. - You can subscribe to or read the list archive at - {% endtrans %} - http://lists.gnu.org/mailman/listinfo/taler. -

-
-
-
-
-

{{ _("Regression Testing") }}

- -

- {% trans %} - We have - {% endtrans %} - Buildbot - {% trans %} - automation tests to detect regressions and check for - portability at - {% endtrans %} - buildbot.taler.net. -

-
-
-

{{ _("Code Coverage Analysis") }}

- -

- {% trans %} - We use - {% endtrans %} - LCOV - {% trans %} - to analyze the code coverage of our tests, the - results are available at - {% endtrans %} - lcov.taler.net. -

-
-
-
-
- -
-
-

{{ _("Technical Presentation") }}

-
- - - - - -
-
-
- -
-
-

{{ _("Taler system overview") }}

- -

- {% trans %} - The Taler system consists of protocols executed among - a number of actors as illustrated in the illustration on the right. - Typical transactions involve the following steps: - {% endtrans %} -

- - {{_( -
    -
  1. - {% trans %} - A customer instructs his bank to - transfer funds from his account to the Taler - exchange (top left). In the subject of the - transaction, he includes an authentication - token from his electronic wallet. In - Taler terminology, the customer creates a - reserve at the exchange. - {% endtrans %} -
  2. - -
  3. - {% trans %} - Once the exchange has received the wire - transfer, it allows the customer's electronic - wallet to withdraw electronic coins. - The electronic coins are digital - representations of the original currency from - the transfer. It is important to note that the - exchange does not learn the "serial - numbers" of the coins created in this - process, so it cannot tell later which customer - purchased what at which merchant. The use of - Taler does not change the currency or the total - value of the funds (except for fees which the - exchange may charge for the service). - {% endtrans %} -
  4. - -
  5. - {% trans %} - Once the customer has the digital coins in his - wallet, the wallet can be used to spend - the coins with merchant portals that support - the Taler payment system and accept the - respective exchange as a business partner - (bottom arrow). This creates a digital contract - signed by the customer's coins and the - merchant. If necessary, the customer can later - use this digitally signed contract in a court - of law to prove the exact terms of the contract - and that he paid the respective amount. The - customer does not learn the banking details of - the merchant, and Taler does not require the - merchant to learn the identity of the - customer. Naturally, the customer can spend any - fraction of his digital coins (the system takes - care of customers getting change). - {% endtrans %} -
  6. - -
  7. - {% trans %} - Merchants receiving digital - coins deposit the respective claims - that resulted from the contract signing with - the customer at the exchange to redeem the - coins. The deposit step does not reveal the - details of the contract between the customer - and the merchant or the identity of the - customer to the exchange in any way. However, - the exchange does learn the identity of the - merchant via the provided bank routing - information. The merchant can, for example - when compelled by the state for taxation, - provide information linking the individual - deposit to the respective contract signed by - the customer. Thus, the exchange's database - allows the state to enforce that merchants pay - applicable taxes (and do not engage in illegal - contracts). - {% endtrans %} -
  8. - -
  9. - {% trans %} - Finally, the exchange transfers funds - corresponding to the digital coins redeemed by - the merchants to the merchant's bank - account. The exchange may combine multiple - small transactions into one larger bank - transfer. The merchant can query the exchange - about the relationship between the bank - transfers and the individual claims that were - deposited. - {% endtrans %} -
  10. - -
  11. - {% trans %} - Most importantly, the exchange keeps - cryptographic proofs that allow it to - demonstrate that it is operating correctly to - third parties. The system requires an - external auditor, such as a - government-appointed financial regulatory body, - to frequently verify the exchange's databases - and check that its bank balance matches the - total value of the remaining coins in - circulation. - {% endtrans %} -
  12. - -
  13. - {% trans %} - Without the auditor, the exchange operators - could embezzle funds they are holding in - reserve. Customers and merchants cannot cheat - each other or the exchange. If any party's - computers are compromised, the financial damage - is limited to the respective party and - proportional to the funds they have in - circulation during the period of the - compromise. - {% endtrans %} -
  14. -
-
- -
-
-
-{% endblock body_content %} diff --git a/template/docs.html.j2 b/template/docs.html.j2 index d78e4258..8c2fa5d6 100644 --- a/template/docs.html.j2 +++ b/template/docs.html.j2 @@ -230,6 +230,22 @@ {{ _("Git repositories for all of GNU Taler.") }} +
+ + +

{{ _("lcov results") }}

+
+ {{ _("Shows results of the code coverage analysis for our test suite.") }} +
+m +
+ + +

{{ _("Continuous integration") }}

+
+ {{ _("Continuous integration and deployment is managed by our Buildbot.") }} +
+ -- cgit v1.2.3