From 2b1527a2afb87ea838b3f3861de92302277986ed Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Wed, 15 Dec 2010 18:01:26 +0000 Subject: [PATCH] CG+web: revise "help us" page and lilybuntu. --- Documentation/contributor/introduction.itexi | 74 +++++++++++++------- Documentation/css/lilypond-mccarty.css | 12 ++++ Documentation/included/helpus.itexi | 48 +++++-------- Documentation/macros.itexi | 26 +++++++ 4 files changed, 105 insertions(+), 55 deletions(-) diff --git a/Documentation/contributor/introduction.itexi b/Documentation/contributor/introduction.itexi index bd81455328..ea97d4eb60 100644 --- a/Documentation/contributor/introduction.itexi +++ b/Documentation/contributor/introduction.itexi @@ -127,42 +127,55 @@ In virtualization terminology, your main operating system is the @qq{host}. @item -Download the @file{lilybuntu.iso} disk image. +Download the @file{lilybuntu2.iso} disk image: @example @uref{http://files.lilynet.net/lilybuntu2.iso} @end example +@advanced{There is a md5sum available: +@uref{http://files.lilynet.net/lilybuntu2.iso.md5}} + @item -Install @file{lilybuntu.iso} as the @qq{client} operating system +Install @file{lilybuntu2.iso} as the @qq{guest} operating system on your virtualized system. @itemize @item -The latest version of lilybuntu is based on Ubuntu 9.04; if you -encounter any difficulties installing it, search for one of the -many tutorials for installing Ubuntu 9.04 as a client operating -system. +If possible, use at least 700 MB of RAM (1GB would be better) for +the virtual machine, and use @qq{dynamically expanding storage} +for the virtual hard drive. A complete compile of everything +(code, docs, regression tests) can reach 10 GB. @item -When @file{lilybuntu.iso} boots, it automatically selects @qq{Try -Ubuntu without any change to your computer}; instead of this, you -must select @qq{Install Ubuntu}. +When @file{lilybuntu2.iso} boots, it shows an ISOLINUX +@code{boot:} prompt. Type: + +@example +install +@end example @item -If possible, use at least 700 MB of RAM (1GB would be better) for -the virtual machine, and use a dynamically expanding virtual hard -drive. A complete compile of everything (code, docs, regression -tests) can reach 10 GB. +At the @qq{Prepare disk space} stage, do not be afraid to select +@qq{Erase and use the entire disk}, since this refers to your +@emph{virtual disk}, not your machine's actual hard drive. @item -At the partitioning stage, do not be afraid to select @qq{use -entire disk}, since this refers to your @emph{virtual disk}, not -your machine's actual hard drive. +After restarting your system, if you see the ISOLINUX @code{boot:} +prompt again, go to +@w{Devices@arrow{}CD/DVD Devices@arrow{}} and @emph{de-select} +the @q{lilybuntu2.iso} option, then reboot. @end itemize +@advanced{ +The latest version of lilybuntu is based on Ubuntu 10.04.1; if you +encounter any difficulties installing it, search for one of the +many tutorials for installing that particular version of Ubuntu as +a client operating system. +} + @item Do any extra configuration for your virtualization software. @@ -183,31 +196,40 @@ From the @code{Places} menu of Ubuntu, select @item Double-click on the @file{autorun.sh} file, then select @qq{Run in -Terminal}. +Terminal}, and enter your password when prompted. @item Once the script is finished, reboot your Virtual Machine to complete the installation. +@advanced{If you do any kernel upgrades, you may need to re-run +these VBOXADDITIONS instructions.} + @end enumerate If you use other virutalization software, then follow the normal -procedures for your virtualization software with Ubuntu 9.04 as -the client. +procedures for your virtualization software with Ubuntu as the +client. @end enumerate Follow instructions for Linux when reading instructions about @ref{Working with source code}, or @ref{Compiling}. -@quotation -Advanced note: not all hardware is supported in all virtualization -tools. In particular, contributors have reported problems with -USB devices. If you would like to investigate further, then look -for help for your virtualization tool using your normal OS as the -@qq{host} and Ubuntu as the @qq{client}. +If you are not familiar with Linux, it may be benefitial to read a +couple of @qq{introduction to Ubuntu} webpages. One particular +change from Windows and MacOS X is that most software should be +installed with your @qq{package manager}; this vastly simplifies +the process of installing and configuring software. Go to +@w{System@arrow{}Administration@arrow{}Synaptic Package Manager}. + -@end quotation +@advanced{not all hardware is supported in all virtualization +tools. In particular, some contributors have reported problems +with USB devices. If you would like to investigate further, then +look for help for your virtualization tool using your normal OS as +the @qq{host} and Ubuntu as the @qq{client}. +} @node Mentors diff --git a/Documentation/css/lilypond-mccarty.css b/Documentation/css/lilypond-mccarty.css index 7bafd33101..9cebcf0394 100644 --- a/Documentation/css/lilypond-mccarty.css +++ b/Documentation/css/lilypond-mccarty.css @@ -455,4 +455,16 @@ div#search p, div#search form { margin: 1em; } +.advanced { + background: #eeffcc; + text-align: left; + padding: 0; + border: 1px solid green; + /* Experimental rounded corners */ + -moz-border-radius: 10px; + -webkit-border-radius: 10px; + margin: 1em 1em 2em 3em; +} + + diff --git a/Documentation/included/helpus.itexi b/Documentation/included/helpus.itexi index 29a0f70bb3..9bd73c5cab 100644 --- a/Documentation/included/helpus.itexi +++ b/Documentation/included/helpus.itexi @@ -7,10 +7,10 @@ The LilyPond development team is quite small; we really want to get more people involved. Please consider helping your fellow -LilyPond users by contributing to development! +LilyPond users by contributing! -Even working on small tasks can have a big impact: taking care -of them let experienced developers work on advanced tasks, instead +Even working on small tasks can have a big impact: taking care of +them allows experienced developers work on advanced tasks, instead of spending time on those simple tasks. @end macro @@ -19,6 +19,8 @@ of spending time on those simple tasks. @macro helpusTasks @subheading Simple tasks +No source code or compiling required! + @itemize @item Mailing list support: answer questions from fellow users. @@ -43,18 +45,23 @@ testing new features. Please contribute to these discussions! @end itemize -@subheading Moderate tasks +@subheading Advanced tasks + +These jobs generally require that you have the source code and can +compile LilyPond. + +@warning{We suggest that contributors using Windows or MacOS X do +@strong{not} attempt to set up their own development environment; +instead, use @rcontrib{Lilybuntu}.} -@warning{These jobs generally require that you have the program -and documentation source files, but do not require a full -development environment. See -@rcontrib{Working with source code}.} +Contributors using Linux or FreeBSD may also use Lilybuntu, but if +they prefer their own development environment, they should read +@rcontrib{Working with source code}, and @rcontrib{Compiling}. @itemize @item -Documentation: see -@rcontrib{Documentation work}, and -@rcontrib{Building documentation without compiling}. +Documentation: for large changes, see +@rcontrib{Documentation work}. @item Website: the website is built from the normal documentation @@ -65,25 +72,8 @@ source. See the info about documentation, and also Translations: see @rcontrib{Translating the documentation}, and @rcontrib{Translating the website}. -@end itemize - - -@subheading Complex tasks - -@warning{These jobs generally require that you have the source -code and can compile LilyPond. See -@rcontrib{Working with source code}, -and @rcontrib{Compiling}. -@*@* -We suggest that new contributors using Windows or MacOS X do -@strong{not} attempt to set up their own development environment; -instead, see -@rcontrib{Lilybuntu}. -} - -@itemize @item -Bugfixes, new features: the best way to begin is to join the +Bugfixes or new features: the best way to begin is to join the Frogs, and read @rcontrib{Programming work}. @end itemize diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi index 8031024c3b..c8a8a2c2ce 100644 --- a/Documentation/macros.itexi +++ b/Documentation/macros.itexi @@ -67,6 +67,32 @@ translations should be in macros.itexi. @end ifnothtml +@ifhtml + +@macro advanced{TEXT} +@html +
+@end html +@strong{Advanced note:} \TEXT\ +@c keep the space for proper nesting of

+ +@html +
+@end html +@end macro + +@end ifhtml + +@ifnothtml + +@macro advanced{TEXT} +@quotation +@b{Advanced note:} \TEXT\ +@end quotation +@end macro + +@end ifnothtml + @macro docMain @cartouche -- 2.39.2