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 c1a6815e9058f0c9e8e77d858a54f530ec951327..c356e1146bd5be4aa5918507cdcae1ffc83ee5b2 100644 (file)
--- a/Documentation/contributor/website-work.itexi
+++ b/Documentation/contributor/website-work.itexi
@@ -3,8 +3,9 @@
 @chapter Website work
 
 @menu
 @chapter Website work
 
 @menu

-* Introduction to website work::  
+* Introduction to website work::

 * Uploading and security::
 * Uploading and security::

+* Debugging website and docs locally::

 * Translating the website::
 @end menu
 
 * Translating the website::
 @end menu
 


@@ -16,10 +17,10 @@ The website is @emph{not} written directly in HTML;
 instead, the source is Texinfo, which is then generated into HTML,
 PDF, and Info formats.  The sources are
 
 instead, the source is Texinfo, which is then generated into HTML,
 PDF, and Info formats.  The sources are
 

-@verbatim
+@example

 Documentation/web.texi
 Documentation/web/*.texi
 Documentation/web.texi
 Documentation/web/*.texi

-@end verbatim
+@end example

 
 Unless otherwise specified, follow the instructions and policies
 given in @ref{Documentation work}.  That chapter also contains a
 
 Unless otherwise specified, follow the instructions and policies
 given in @ref{Documentation work}.  That chapter also contains a


@@ -39,11 +40,17 @@ subsections or subsubsections.
 link to any pieces of automatically generated documentation, like
 the IR or certain NR appendices.
 
 link to any pieces of automatically generated documentation, like
 the IR or certain NR appendices.
 

+@item
+The bibliography in Community->Publications is generated automatically
+from @file{.bib} files; formatting is done automatically by
+@file{texi-web.bst}.
+
+@item

 @dots{}
 
 @item
 For anything not listed here, just follow the same style as the
 @dots{}
 
 @item
 For anything not listed here, just follow the same style as the

-existing texinfo files.
+existing website texinfo files.

 
 @end itemize
 
 
 @end itemize
 


@@ -77,6 +84,32 @@ chgrp lilypond ~graham/lilypond/ -R
 chmod 775 ~graham/lilypond/ -R
 @end example
 
 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
+@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.
+
+Upload latest pictures/ and ly-examples/ (local script):
+
+@warning{You may need to change a number of items in the below
+script.}
+
+@verbatim
+### upload-lily-web-media.sh
+#!/bin/sh
+BUILD_DIR=$HOME/src/build-lilypond
+
+PICS=$BUILD_DIR/Documentation/pictures/out-www/
+EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
+
+cd $BUILD_DIR
+rsync -a $PICS graham@lilypond.org:lilypond/media/pictures
+rsync -a $EXAMPLES graham@lilypond.org:lilypond/media/ly-examples
+@end verbatim
+
+

 
 @subheading Normal maintenance
 
 
 @subheading Normal maintenance
 


@@ -91,7 +124,7 @@ git merge origin/master
 @end verbatim
 
 Check for any updates to trusted scripts / files:
 @end verbatim
 
 Check for any updates to trusted scripts / files:

-
+@smallexample

 @verbatim
 ### check-git.sh
 #!/bin/sh
 @verbatim
 ### check-git.sh
 #!/bin/sh


@@ -104,6 +137,7 @@ diff -u $DEST/create-version-itexi.py $GIT/scripts/build/create-version-itexi.py
 diff -u $DEST/create-weblinks-itexi.py $GIT/scripts/build/create-weblinks-itexi.py
 diff -u $DEST/mass-link.py $GIT/scripts/build/mass-link.py
 diff -u $DEST/website_post.py $GIT/scripts/build/website_post.py
 diff -u $DEST/create-weblinks-itexi.py $GIT/scripts/build/create-weblinks-itexi.py
 diff -u $DEST/mass-link.py $GIT/scripts/build/mass-link.py
 diff -u $DEST/website_post.py $GIT/scripts/build/website_post.py

+diff -u $DEST/bib2texi.py $GIT/scripts/build/bib2texi.py

 diff -u $DEST/lilypond.org.htaccess $GIT/Documentation/web/server/lilypond.org.htaccess
 diff -u $DEST/website-dir.htaccess $GIT/Documentation/web/server/website-dir.htaccess
 @end verbatim
 diff -u $DEST/lilypond.org.htaccess $GIT/Documentation/web/server/lilypond.org.htaccess
 diff -u $DEST/website-dir.htaccess $GIT/Documentation/web/server/website-dir.htaccess
 @end verbatim


@@ -122,9 +156,11 @@ cp $GIT/scripts/build/create-version-itexi.py $DEST/create-version-itexi.py
 cp $GIT/scripts/build/create-weblinks-itexi.py $DEST/create-weblinks-itexi.py
 cp $GIT/scripts/build/mass-link.py $DEST/mass-link.py
 cp $GIT/scripts/build/website_post.py $DEST/website_post.py
 cp $GIT/scripts/build/create-weblinks-itexi.py $DEST/create-weblinks-itexi.py
 cp $GIT/scripts/build/mass-link.py $DEST/mass-link.py
 cp $GIT/scripts/build/website_post.py $DEST/website_post.py

+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
 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:
 
 
 Build the website:
 


@@ -152,34 +188,45 @@ Cronjob to automate the trusted portions:
 @end verbatim
 
 
 @end verbatim
 
 

-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 @strong{not}
-compiled.  If you modify any files in those directories, a user in
-the @code{lilypond} group must upload them to @file{~graham/media}
-on the host.
+@subsubheading Additional information

 
 

-Upload latest pictures/ and ly-examples/ (local script):
+Some information about the website is stored in
+@file{~graham/lilypond/*.txt}; this information should not be
+shared with people without trusted access to the server.

 
 

-@verbatim
-### upload-lily-web-media.sh
-#!/bin/sh
-BUILD_DIR=$HOME/src/build-lilypond

 
 

-PICS=$BUILD_DIR/Documentation/pictures/out-www/
-EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
+@node Debugging website and docs locally
+@section Debugging website and docs locally

 
 

-cd $BUILD_DIR
-rsync -a $PICS graham@lilypond.org:media/pictures
-rsync -a $EXAMPLES graham@lilypond.org:ly-examples
-@end verbatim
+@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:

 
 

-@subsubheading Additional information
+@example
+make WEB_TARGETS="offline online" doc
+make website
+@end example

 
 

-Some information about the website is stored in
-@file{~graham/lilypond/*.txt}; this information should not be
-shared with people without trusted access to the server.
+
+@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
 
 
 @node Translating the website