Add basic build stuff.
[gnupg-doc.git] / README
1 README for the website branch.                           -*- org -*-
2
3 This is a separated branch for the gnupg.org website.
4
5 The old website was tracked in a CVS repository but we want to start
6 the new website form scratch using only the texts from the generated
7 HTML files.
8
9 ** Directory structure
10
11    - web/ :: Source files for the web.  This also include imagages
12              etc.
13    - web/share :: Logos, CSS, macros and elisp for building.
14    - tools/ :: Tools used to build the web site.
15    - stage/ :: staging directory for the site.
16
17 ** Aliases
18
19 www.gnupg.org uses boa to serve the pages, here are the aliases we
20 use:
21
22 #+BEGIN_EXAMPLE
23 # The manuals are maintained outside of the web pages;
24 # thus we use an alias to copy them in.
25 Alias /documentation/manuals /var/www/shared/manuals
26 Alias /gph /var/www/shared/gph
27
28 # The FAQ is located in the manuals directory but linked to the faq directory
29 Alias /faq/GnuPG-FAQ.html  /var/www/shared/manuals/GnuPG-FAQ.html
30
31
32 # Redirect a couple of well-known URLs
33 Redirect /gpa.html      http://www.gnupg.org/related_software/gpa/
34 Redirect /gpgme.html    http://www.gnupg.org/related_software/gpgme/
35 Redirect /docs.html     http://www.gnupg.org/documentation/
36 Redirect /download.html http://www.gnupg.org/download/
37 Redirect /faq.html      http://www.gnupg.org/documentation/faqs.html
38
39 # We use redirect to make language switching work.
40 Redirect /why-not-idea.html  http://www.gnupg.org/faq/why-not-idea.html
41
42 Redirect /howtos/ch/  http://www.gnupg.org/howtos/zh/
43 #+END_EXAMPLE