diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/example-essay-store.rst | 73 | ||||
-rwxr-xr-x | docs/exchange-db-generate.sh | 3 | ||||
-rw-r--r-- | docs/exchange-db.png | bin | 0 -> 198095 bytes | |||
-rw-r--r-- | docs/global-licensing.rst (renamed from docs/global_licensing.rst) | 0 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/releases.rst | 103 | ||||
-rw-r--r-- | docs/versioning.rst | 60 |
7 files changed, 207 insertions, 34 deletions
diff --git a/docs/example-essay-store.rst b/docs/example-essay-store.rst index 8a32aa1d..4687083c 100644 --- a/docs/example-essay-store.rst +++ b/docs/example-essay-store.rst @@ -94,40 +94,47 @@ After the rendering, (part of) ``purchase.html`` will look like shown below. .. sourcecode:: html - ... - <script src="/static/web-common/taler-wallet-lib.js" type="application/javascript"></script> - <script src="/static/purchase.js" type="application/javascript"></script> - ... - <meta name="contract_url" value="https://shop.demo.taler.net/generate-contract?article_name=Appendix_A:_A_Note_on_Software"> - - ... - ... - - <div id="ccfakeform" class="fade"> - <p> - Oops, it looks like you don't have a Taler wallet installed. Why don't you enter - all your credit card details before reading the article? <em>You can also - use GNU Taler to complete the purchase at any time.</em> - </p> - - <form> - First name<br> <input type="text"></input><br> - Family name<br> <input type="text"></input><br> - Age<br> <input type="text"></input><br> - Nationality<br> <input type="text"></input><br> - Gender<br> <input type="radio" name"gender">Male</input> - CC number<br> <input type="text"></input><br> - <input type="radio" name="gender">Female</input><br> - </form> - <form method="get" action="/cc-payment/{{ article_name }}"> - <input type="submit"></input> - </form> - </div> + <html> + <head> + <!-- ... --> + <script src="/static/web-common/taler-wallet-lib.js" type="application/javascript"></script> + <script src="/static/purchase.js" type="application/javascript"></script> + <!-- ... --> + <meta name="contract_url" value="https://shop.demo.taler.net/generate-contract?article_name=Appendix_A:_A_Note_on_Software"> + + </head> + <body> + <!-- ... --> + <!-- ... --> - <div id="talerwait"> - <em>Processing payment with GNU Taler, please wait <span id="action-indicator"></span></em> - </div> - ... + <div id="ccfakeform" class="fade"> + <p> + Oops, it looks like you don't have a Taler wallet installed. Why don't you enter + all your credit card details before reading the article? <em>You can also + use GNU Taler to complete the purchase at any time.</em> + </p> + <form> + First name<br> <input type="text"></input><br> + Family name<br> <input type="text"></input><br> + Age<br> <input type="text"></input><br> + Nationality<br> <input type="text"></input><br> + Gender<br> <input type="radio" name="gender">Male</input> + CC number<br> <input type="text"></input><br> + <input type="radio" name="gender">Female</input><br> + </form> + + <form method="get" action="/cc-payment/{{ article_name }}"> + <input type="submit"></input> + </form> + </div> + + <div id="talerwait"> + <em>Processing payment with GNU Taler, please wait <span id="action-indicator"></span></em> + </div> + <!-- ... --> + </body> + </html> + The script ``purchase.js`` is now in charge of implementing the behaviour we seek. It needs to register two handlers: one called whenever the wallet is detected in the diff --git a/docs/exchange-db-generate.sh b/docs/exchange-db-generate.sh new file mode 100755 index 00000000..b296e0c9 --- /dev/null +++ b/docs/exchange-db-generate.sh @@ -0,0 +1,3 @@ +#!/bin/sh +taler-exchange-dbinit -r +java -jar schemaSpy_5.0.0.jar -t pgsql -db taler -o taler -host localhost -dp /usr/share/java/postgresql-jdbc3-9.2.jar -u grothoff -p test -s public -hq diff --git a/docs/exchange-db.png b/docs/exchange-db.png Binary files differnew file mode 100644 index 00000000..ddc25591 --- /dev/null +++ b/docs/exchange-db.png diff --git a/docs/global_licensing.rst b/docs/global-licensing.rst index 7a5e8226..7a5e8226 100644 --- a/docs/global_licensing.rst +++ b/docs/global-licensing.rst diff --git a/docs/index.rst b/docs/index.rst index a4982149..b577ad03 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,7 +51,7 @@ It focuses on how to install, configure and run the required software. .. toctree:: :maxdepth: 2 - global_licensing + global-licensing configuration-basics operate-exchange operate-merchant diff --git a/docs/releases.rst b/docs/releases.rst new file mode 100644 index 00000000..d0191ba0 --- /dev/null +++ b/docs/releases.rst @@ -0,0 +1,103 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2016 INRIA + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> + + @author Florian Dold + + +============================== +Release Process and Checklists +============================== + +This document describes the process for releasing a new version of the various +Taler components to the official GNU mirrors. + +The following components are published on the GNU mirrors + +* taler-exchange (exchange.git) +* taler-merchant (merchant.git) +* talerfrontends (merchant-frontends.git) +* taler-bank (bank.git) +* taler-wallet-webex (wallet-webex.git) + + +------- +Tagging +------- + +Tag releases with an *annotated* commit, like + +:: + + git tag -a v0.1.0 -m "Official release v0.1.0" + git push origin v0.1.0 + +------------------ +Database for tests +------------------ + +For tests in the exchange and merchant to run, make sure that +a database `talertest` is accessible by `$USER`. Otherwise tests +involving the database logic are skipped. + +------------------ +Exchange, merchant +------------------ + +Set the version in `configure.ac`. The commit being tagged +should be the change of the version. + +For the exchange test cases to pass, `make install` must be run first. +Without it, test cases will fail because plugins can't be located. + +:: + + ./bootstrap + ./configure # add required options for your system + make dist + tar -xf taler-$COMPONENT-$VERSION.tar.gz + cd taler-$COMPONENT-$VERSION + make install check + +-------------------- +Wallet WebExtension +-------------------- + +The version of the wallet is in `manifest.json`. The `version_name` should be +adjusted, and `version` should be increased independently on every upload to +the WebStore. + +:: + + ./configure + make dist + + + +FIXME: selenium test cases + + +---------------------- +Upload to GNU mirrors +---------------------- + +See https://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads + +Directive file: + +:: + + version: 1.2 + directory: taler + filename: taler-exchange-0.1.0.tar.gz + + +Upload the files in *binary mode* to the ftp servers. diff --git a/docs/versioning.rst b/docs/versioning.rst new file mode 100644 index 00000000..14336da0 --- /dev/null +++ b/docs/versioning.rst @@ -0,0 +1,60 @@ +.. + This file is part of GNU TALER. + Copyright (C) 2014, 2015, 2016 INRIA + + TALER is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 2.1, or (at your option) any later version. + + TALER is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public License along with + TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> + + @author Christian Grothoff + +================== +GNU Taler Versions +================== + +This text describes how we assign version numbers for Taler software. +This is about the version numbers of package releases, not of the +libraries. For Taler libraries, we use libtool semantic versioning +conventions. + +Taler software release version numbers use the scheme +MAJOR.MINOR-PACKAGE. + +Here, MAJOR is used to indicate the compatibility level and is +increased for all significant releases that are always made across all +Taler components. + +The MINOR numbers is used for small updates that may address minor +issues but do not break compatibility. MINOR release may be made only +for a particular component, leaving other components untouched. Hence +you should expect to see say an exchange version 4.5 and a wallet +version 4.10. As they both start with "4", they are expected to be +protocol-compatible. + +PACKAGE is reserved for distributions, such as Debian. These distributions +may apply their own patch sets or scripting, and they are expected to +increment PACKAGE. The upstream Taler releases will just be of the +format MAJOR.MINOR. + +----------------------- +Alpha and Beta releases +----------------------- + +Before Taler is considered reasonably stable for actual use, we will +prefix the number "0." to the release version. Thus, all alpha and +beta releases will have a three-digit release number of the form +"0.MAJOR.MINOR". + +----------------------- +Roadmap +----------------------- + +A roadmap with the features we plan to have in each release is +in our bugtracker at https://gnunet.org/bugs/. The roadmap +is subject to change. |