boilerplate for onboarding documentation

2 files changed, 75 insertions, 12 deletions

diff --git a/doc/onboarding.texi b/doc/onboarding.texi
index 3327b2a..dafc05f 100644
--- a/doc/onboarding.texi
+++ b/doc/onboarding.texi
@@ -1,3 +1,61 @@
+\input texinfo @c -*-texinfo-*-
+@c %**start of header
+@setfilename onboarding.info
+@include version.texi
+@settitle Notes for taler.net admins and developers @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 INRIA
+
+@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 Notes for taler.net admins and developers
+@subtitle Version @value{VERSION}
+@subtitle @value{UPDATED}
+@author Marcello Stanisci (@email{marcello.stanisci@@inria.fr})
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@c @summarycontents
+@contents
+
+@ifnottex
+@node Top
+@top Notes for taler.net admins and developers
+@insertcopying
+@end ifnottex
+
+@menu
+* Taler.net::                           Sysadmins notes for server at taler.net
+* Standalone deployment::               Deploy Taler in your homepage
+* Deployment on demo.taler.net::        Deploy Taler in a "blue/green" fashion
+* Releases::                            Releases patterns
+@end menu
+
 @node Taler.net
 @section Taler.net
 
@@ -107,14 +165,14 @@ After the desired blue/green party has been compiled, it is possible to
 log-in as @emph{test} and run the script @code{$HOME/.ln-<COLOR>.sh}, in order to make
 @code{test-<COLOR>} active.
 
--------------------
-Site lcov.taler.net
--------------------
+@subsubsection Website lcov.taler.net
 
 The directory @code{/var/www/lcov.taler.net} contains the following two symlinks
 
-* exchange --> @code{/home/lcovslave/exchange/doc/coverage}
-* merchant --> @code{/home/lcovslave/merchant/doc/coverage}
+@itemize
+@item exchange --> @code{/home/lcovslave/exchange/doc/coverage}
+@item merchant --> @code{/home/lcovslave/merchant/doc/coverage}
+@end itemize
 
 The pointed locations are updated by the @emph{lcovslave}.
 
@@ -125,7 +183,7 @@ The pointed locations are updated by the @emph{lcovslave}.
 
 This tecnique aims to set a thorough Taler installation up on a
 machine whose nginx configuration is configured by config files
-from @indicateurl{https://git.taler.net/deployment.git/tree/etc/nginx}.
+from @emph{https://git.taler.net/deployment.git/tree/etc/nginx}.
 
 This installation assumes that all the steps are run with @code{$HOME}
 as @code{$CWD}.
@@ -155,7 +213,7 @@ which is
 
 @quotation
 
-@example
+@smallexample
 WARNING: enabling "trust" authentication for local connections
 You can change this by editing pg_hba.conf or using the option -A, or
 --auth-local and --auth-host, the next time you run initdb.
@@ -163,7 +221,7 @@ You can change this by editing pg_hba.conf or using the option -A, or
 Success. You can now start the database server using:
 
 /usr/lib/postgresql/9.5/bin/pg_ctl -D talerdb -l logfile start
-@end example
+@end smallexample
 
 The reason is that this message is generated by Postgresql's utilities and
 you never need to start your database manually; it will be started by the
@@ -260,7 +318,7 @@ at @code{<DEPLOYMENT-REPO>/etc/nginx}.
 @node Deployment on demo.taler.net
 @section Deployment on demo.taler.net
 
-This section describes how to upgrade the exchange deployment on the
+This section describes how to upgrade the whole Taler setup on the
 @url{taler.net} Web site.  Here, the deployment scripts include a
 ``stable'' setup at @url{demo.taler.net} and an ``experimental'' setup
 at @url{test.taler.net}.  This section documents the steps for moving
@@ -328,9 +386,8 @@ $ taler-deployment-start
 
 Now the symlink can be updated.
 
-@node releases
-@section releases
-
+@node Releases
+@section Releases
 
 @subsection Release Process and Checklists
 
@@ -408,3 +465,5 @@ filename: taler-exchange-0.1.0.tar.gz
 @end example
 
 Upload the files in @b{binary mode} to the ftp servers.
+
+@bye
diff --git a/doc/version.texi b/doc/version.texi
new file mode 100644
index 0000000..1bd19c2
--- /dev/null
+++ b/doc/version.texi
@@ -0,0 +1,4 @@
+@set UPDATED 31 May 2017
+@set UPDATED-MONTH May 2017
+@set EDITION 0.2.0
+@set VERSION 0.2.0