Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git

[lilypond.git] / Documentation / contributor / website-work.itexi

diff --git a/Documentation/contributor/website-work.itexi b/Documentation/contributor/website-work.itexi
index 4921da3a54ba7af308f329826dadb081050784cc..c356e1146bd5be4aa5918507cdcae1ffc83ee5b2 100644 (file)
--- a/Documentation/contributor/website-work.itexi
+++ b/Documentation/contributor/website-work.itexi
@@ -5,6 +5,7 @@
 @menu
 * Introduction to website work::
 * Uploading and security::
+* Debugging website and docs locally::
 * Translating the website::
 @end menu
 
@@ -66,16 +67,16 @@ scripts are examined and copied to
 @subheading Initial setup
 
 You should symlink your own @file{~/lilypond/} to
-@file{~graham/@/lilypond/}
+@file{~graham/lilypond/}
 
 If this directory does not exist, make it.  Git master should go
-in @file{~/lilypond/@/lilypond@/-git/} but make sure you enable:
+in @file{~/lilypond/lilypond-git/} but make sure you enable:
 
 @example
 git config core.filemode false
 @end example
 
-If you have created any files in @file{~graham/@/lilypond/} then
+If you have created any files in @file{~graham/lilypond/} then
 please run:
 
 @example
@@ -84,11 +85,11 @@ chmod 775 ~graham/lilypond/ -R
 @end example
 
 To reduce the CPU burden on the shared host (as well as some
-security concerns), the @file{Documentation/@/pictures/} and
-@file{Documentation/@/web/@/ly-examples/} directories are
+security concerns), the @file{Documentation/pictures/} and
+@file{Documentation/web/ly-examples/} directories are
 @strong{not} compiled.  You need to upload them, and if they ever
 change, a user in the @code{lilypond} group must upload them to
-@file{~graham/@/lilypond@/media} on the host.
+@file{~graham/lilypond/media} on the host.
 
 Upload latest pictures/ and ly-examples/ (local script):
 
@@ -123,7 +124,7 @@ git merge origin/master
 @end verbatim
 
 Check for any updates to trusted scripts / files:
-
+@smallexample
 @verbatim
 ### check-git.sh
 #!/bin/sh
@@ -159,6 +160,7 @@ cp $GIT/scripts/build/bib2texi.py $DEST/bib2texi.py
 cp $GIT/Documentation/web/server/lilypond.org.htaccess $DEST/lilypond.org.htaccess
 cp $GIT/Documentation/web/server/website-dir.htaccess $DEST/website-dir.htaccess
 @end verbatim
+@end smallexample
 
 Build the website:
 
@@ -189,10 +191,44 @@ Cronjob to automate the trusted portions:
 @subsubheading Additional information
 
 Some information about the website is stored in
-@file{~graham/@/lilypond/@/*.txt}; this information should not be
+@file{~graham/lilypond/*.txt}; this information should not be
 shared with people without trusted access to the server.
 
 
+@node Debugging website and docs locally
+@section Debugging website and docs locally
+
+@itemize
+@item
+Install apache2, or any other http server.  These instructions
+assume that you also enable @code{mod_userdir}, and use
+@code{$HOME/public_html} as the location.
+
+@item
+Build the online docs and website:
+
+@example
+make WEB_TARGETS="offline online" doc
+make website
+@end example
+
+
+@item
+Move the built stuff into those directories.  It's highly
+recommended to have your build dir and www dir on the same
+partition.  (make @code{$HOME/public_html/} a symlink if
+necessary)
+
+@example
+mv out-website/website/ $HOME/public_html
+mv $HOME/public_html/website/pictures $HOME/public_html/
+mkdir -p $HOME/public_html/doc/v2.13/
+mv out-www/online-root/* $HOME/public_html/doc/v2.13/
+@end example
+
+@end itemize
+
+
 @node Translating the website
 @section Translating the website
 
@@ -215,7 +251,7 @@ make website
 however, please note that this command is not designed for being
 run multiple times.  If you see unexpected output (mainly the page
 footers getting all messed up), then delete your
-@file{out@/-website} directory and run @code{make website} again.
+@file{out-website} directory and run @code{make website} again.
 
 @item
 Some of the translation infrastructure is defined in python files;
@@ -229,7 +265,7 @@ scripts/build/website_post.py
 @item
 Translations are not included by default in @code{make website}.
 To test your translation, edit the @code{WEB_LANGS} line in
-@file{make/@/website@/.make}.  Do not submit a patch to add your language
+@file{make/website.make}.  Do not submit a patch to add your language
 to this file unless @code{make website} completes with less than 5
 warnings.