From 35e49b858a29578f6b4925de2e56a80b829e9c59 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 29 Aug 2019 12:35:13 +0200 Subject: move documentation to docs repo --- doc/Makefile | 13 ---- doc/docstyle.css | 85 ------------------------- doc/manual.texi | 185 ------------------------------------------------------- doc/version.texi | 4 -- 4 files changed, 287 deletions(-) delete mode 100644 doc/Makefile delete mode 100644 doc/docstyle.css delete mode 100644 doc/manual.texi delete mode 100644 doc/version.texi diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index c69c2b9..0000000 --- a/doc/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -all: manual.pdf manual.html - -manual.pdf: manual.texi - texi2pdf manual.texi - -manual.html: manual.texi - texi2any --html --no-split --css-ref=docstyle.css --css-ref=brown-paper.css manual.texi - -clean: - rm -f manual.html manual.pdf - -info_TEXINFOS = manual.texi -manual_TEXINFOS = version.texi diff --git a/doc/docstyle.css b/doc/docstyle.css deleted file mode 100644 index 1a3a88b..0000000 --- a/doc/docstyle.css +++ /dev/null @@ -1,85 +0,0 @@ -html, body { - font-size: 1em; - text-align: left; - text-decoration: none; -} -html { background-color: #e7e7e7; } - -body { - max-width: 74.92em; - margin: 0 auto; - padding: .5em 1em 1em 1em; - background-color: white; - border: .1em solid #c0c0c0; -} - -h1, h2, h3, h4 { color: #333; } -h5, h6, dt { color: #222; } - - -a h3 { - color: #005090; -} - -a[href] { color: #005090; } -a[href]:visited { color: #100070; } -a[href]:active, a[href]:hover { - color: #100070; - text-decoration: none; -} - -.linkrow { - margin: 3em 0; -} - -.linkrow { - text-align: center; -} - -div.example { padding: .8em 1.2em .4em; } -pre.example { padding: .8em 1.2em; } -div.example, pre.example { - margin: 1em 0 1em 3% ; - -webkit-border-radius: .3em; - -moz-border-radius: .3em; - border-radius: .3em; - border: 1px solid #d4cbb6; - background-color: #f2efe4; -} -div.example > pre.example { - padding: 0 0 .4em; - margin: 0; - border: none; -} - -pre.smallexample { - margin: 1em 0 1em 3% ; - -webkit-border-radius: .3em; - -moz-border-radius: .3em; - border-radius: .3em; - border: 1px solid #d4cbb6; - background-color: #f2efe4; -} - - -/* This makes the very long tables of contents in Gnulib and other - manuals easier to read. */ -.contents ul, .shortcontents ul { font-weight: bold; } -.contents ul ul, .shortcontents ul ul { font-weight: normal; } -.contents ul { list-style: none; } - -/* For colored navigation bars (Emacs manual): make the bar extend - across the whole width of the page and give it a decent height. */ -.header, .node { margin: 0 -1em; padding: 0 1em; } -.header p, .node p { line-height: 2em; } - -/* For navigation links */ -.node a, .header a { display: inline-block; line-height: 2em; } -.node a:hover, .header a:hover { background: #f2efe4; } - -table.cartouche { - border-collapse: collapse; - border-color: darkred; - border-style: solid; - border-width: 3px; -} diff --git a/doc/manual.texi b/doc/manual.texi deleted file mode 100644 index 1eff954..0000000 --- a/doc/manual.texi +++ /dev/null @@ -1,185 +0,0 @@ -\input texinfo @c -*-texinfo-*- -@c %**start of header -@setfilename manual.info -@include version.texi -@settitle Back-office Web service manual @value{VERSION}. - -@c Define a new index for options. -@defcodeindex op -@c Combine everything into one index (arbitrarily chosen to be the -@c concept index). -@syncodeindex op cp -@c %**end of header - -@copying -Howtos for taler.net admins and developers (version @value{VERSION}, @value{UPDATED}), -Copyright @copyright{} 2017-2018 Taler Systems SA. - -@quotation -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license is included in the section entitled -``GNU Free Documentation License''. -@end quotation -@end copying -@c If your manual is published on paper by the FSF, it should include -@c The standard FSF Front-Cover and Back-Cover Texts, as given in -@c maintain.texi. -@c -@c Titlepage -@c -@titlepage -@title Back-office Web service manual. -@subtitle Version @value{VERSION} -@subtitle @value{UPDATED} -@author Marcello Stanisci (@email{marcello@@taler.net}) -@author Christian Grothoff (@email{grothoff@@taler.net}) -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@c @summarycontents -@contents - -@ifnottex -@node Top -@top Back-office Web service manual. -@insertcopying -@end ifnottex - -@menu -* Introduction:: What is provided by the Web service. -* Installation:: Where to find the code and how to install it. -* Configuration:: How to configure the Web service. -* Launching the backoffice:: How to run the Web service. -@end menu - -@node Introduction -@chapter Introduction - -The back-office Web service allows a merchant to check on the status -of their Taler transactions. Merchants can check if and when they were -paid by a wire transfer for coins deposited at the exchange. Also, given -a wire transfer they have received, they can ask which Taler transactions -correspond to the wire transfer. - -This manual guides merchant system administrators through the -installation and configuration of this Web service. - -@node Installation -@chapter Installation - -The back-office Web service code is available at -@code{git://taler.net/backoffice}. The application can be installed -in a GNU-ish fashion. - -@example -# Get the code: -$ git clone git://taler.net/backoffice - -# Bootstrap and configure -$ cd backoffice -$ ./bootstrap -# This step will check if the system is ready to -# allow the installation. -$ ./configure --prefix= -$ make install -@end example - -Note that to make the application work @code{/bin} must be -included in the @code{$PATH}, and -@code{/lib/python3.5/site-packages/} in @code{$PYTHONPATH}. - - -@node Configuration -@chapter Configuration - -The following information must be provided in the configuration: on which -address the backend should serve the Web site, which currency is used, -and which merchant backend this Web service will work with. - -The merchant backend is an important agent, as it is responsible for -returning information about transactions and wire transfers. The -backoffice Web service is merely a frontend for it. A separate -manual (available at -@url{https://docs.taler.net/merchant/backend/html/manual.html}) -describes the installation and configuration of the merchant backend. - -Assuming the reader is familiar with configuration in Taler (if not, read: -@url{https://docs.taler.net/exchange/html/taler-exchange.html#Configuration-format}), -a working configuration example is the following one: - -@example - -[taler] -# will be EUR, USD, or whatever currency the merchant -# works with. -currency = KUDOS - -# each back-office Web service is associated with a "frontend -# name": this name instructs the application which configuration -# section is going to be read. Thus is the "frontend name" -# and must be specified on the command line via the "--frontend" -# option. See the 'Run' chapter for more details on launching the -# application. -[backoffice-] - -# This option sets the way the backoffice communicates -# when it is instructed to operate via UWSGI. Therefore, -# can be: TCP or UNIX. If TCP is given, then the -# additional UWSGI_PORT option becomes necessary. -uwsgi_serve = - -# those options will be read if the Web site is served via -# WSGI. -uwsgi_unixpath_mode = 660 -uwsgi_unixpath = /path/to/backoffice-.uwsgi -uwsgi_unixmode = 666 - -# If UWSGI_SERVE were set as 'TCP', then the following option -# would have been necessary. It instructs the backoffice service -# about which TCP port should be listened on, to communicate over -# UWSGI. -# uwsgi_port = 8080 - -# this option will be read if the Web site is served via -# HTTP. -http_port = 5959 - -# specifies which merchant backend is going to be used. -backend = http://backend.test.taler.net/ - -# Informally speaking, each instance points to both a private -# key that can sign proposals and a bank account that can receive -# wire transfers by some exchange. - -# Here, is just a string (with no spaces) that will -# make the referenced instance be traceable by the back-office Web -# application. - -instances = .. -@end example - -@node Launching the backoffice -@chapter Launching the backoffice - -The following example shows how to run the Web service. - -@example -# such invocation will work only if the configuration contains -# a section called "[backoffice-myshop]" which looks like the -# example above. - -# As of serving, the Web site will be available via HTTP, at the -# port specified in the configuration option "http_port", at localhost. - -$ taler-merchant-backoffice --frontend myshop serve-http -@end example - -Other options, such as those to serve the site via WSGI, are explained -in the man page and can be listed using the @code{--help} argument. - -@bye diff --git a/doc/version.texi b/doc/version.texi deleted file mode 100644 index cdc4b4d..0000000 --- a/doc/version.texi +++ /dev/null @@ -1,4 +0,0 @@ -@set UPDATED 16 Jan 2018 -@set UPDATED-MONTH Jan 2018 -@set EDITION 0.0.0 -@set VERSION 0.0.0 -- cgit v1.2.3