documenting /landing's serving

1 files changed, 42 insertions, 0 deletions

diff --git a/doc/onboarding.texi b/doc/onboarding.texi
index 6ed2024..adfe58e 100644
--- a/doc/onboarding.texi
+++ b/doc/onboarding.texi
@@ -59,6 +59,48 @@ Texts.  A copy of the license is included in the section entitled
 @node Taler.net
 @chapter Taler.net
 
+@section Landing page
+
+The 'landing' page is the first page that should be visited during a "demo session".
+It is statically served and hosted at @code{$USER/landing/}, where @code{$USER} is one
+of @code{test-@{blue,green@}} or @code{demo-@{blue,green@}}.  Its source code is
+available at the repository: @code{git://taler.net/landing}.
+
+Before being served, the site needs to be compiled, to make the i18n content.  The
+compilation is done in the following way:
+
+@example
+$ cd <landing's top directory>
+$ git submodule update --force --init
+$ AUTOMAKE="automake --foreign" autoreconf -fiv
+$ ./configure
+$ cd demo/
+$ make
+
+# NOTE: the sysadmin will _hardly_ need to do this manually, as there are deployment
+# scripts in charge of the compilation.
+@end example
+
+The most interesting part of nginx's configuration that serves the landing page
+is the following one:
+
+@example
+
+location / @{
+  ...
+  # always default to english
+  rewrite ^/$ /en/ redirect; 
+  # explicit append of "index.html"
+  rewrite ^/(..)/$ /$1/index.html break;
+  ...
+  # NOTE: /home/test/landing and /home/demo/landing
+  # are symlinks to the currently active "blue or green" party.
+  # Next chapters explain the "blue/green" deployment technique.
+  root /home/<'test' or 'demo'>/landing/demo;
+  ...
+  @}
+@end example
+
 @section Git
 
 Git at @code{taler.net} is managed by @emph{gitolite}.  Creation and deletion