Release info for GnuPG 1.4.16
[gnupg-doc.git] / README
1 README for the gnupg-doc repository                         -*- 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 images
12                   etc.
13    - web/share :: Logos, CSS, macros and elisp for building.
14    - misc      :: Otehr websites etc.
15    - build-aux :: Build helper rscripts
16    - tools/    :: Tools used to build the web site.
17    - stage/    :: staging directory for the site.
18
19 ** Aliases
20
21 www.gnupg.org uses Boa to serve the pages, here are the aliases we
22 use:
23
24 #+BEGIN_EXAMPLE
25 # The manuals are maintained outside of the web pages;
26 # thus we use an alias to copy them in.
27 Alias /documentation/manuals /var/www/shared/manuals
28 Alias /gph /var/www/shared/gph
29
30 # The FAQ is located in the manuals directory but linked to the faq directory
31 Alias /faq/GnuPG-FAQ.html  /var/www/shared/manuals/GnuPG-FAQ.html
32
33
34 # Redirect a couple of well-known URLs
35 Redirect /gpa.html      http://www.gnupg.org/related_software/gpa/
36 Redirect /gpgme.html    http://www.gnupg.org/related_software/gpgme/
37 Redirect /docs.html     http://www.gnupg.org/documentation/
38 Redirect /download.html http://www.gnupg.org/download/
39 Redirect /faq.html      http://www.gnupg.org/documentation/faqs.html
40
41 # We use redirect to make language switching work.
42 Redirect /why-not-idea.html  http://www.gnupg.org/faq/why-not-idea.html
43
44 Redirect /howtos/ch/  http://www.gnupg.org/howtos/zh/
45
46 Redirect /fund   http://goteo.org/project/gnupg-new-website-and-infrastructure
47
48 #+END_EXAMPLE
49
50 The howtos are symlinked into the www.gnupg.org tree.
51
52
53 ** Symlinks
54
55 For compatibility with the old webseite it is best to run this script
56 in the htdocs directory:
57
58 for d in $(find . -type d); \\
59    do (cd $d && for f in $(ls *.html | grep -v '*.??.html'); \\
60        do ln -s $f ${f%.html}.en.html; ln -s $f ${f%.html}.de.html ; \\
61    done ); done