Documentation/devel/lsr-work.itexi

   1 @c -*- coding: us-ascii; mode: texinfo; -*-
   2 @node LSR work
   3 @chapter LSR work
   4
   5 @menu
   6 * Introduction to LSR::
   7 * Adding snippets::
   8 * Approving snippets::
   9 * LSR to git::
  10 @end menu
  11
  12
  13 @node Introduction to LSR
  14 @section Introduction to LSR
  15
  16 The
  17 @uref{http://lsr.dsi.unimi.it/, LilyPond Snippet Repository (LSR)}
  18 is a collection of lilypond examples.  A subset of these examples
  19 are automatically imported into the documentation, making it easy
  20 for users to contribute to the docs without learning git and
  21 texinfo.
  22
  23
  24 @node Adding snippets
  25 @section Adding snippets
  26
  27 When you create (or find!) a nice snippet, please add it to LSR.
  28 Go to @uref{http://lsr.dsi.unimi.it/, LSR} and log in (if you
  29 haven't already, create an account).  Follow the instructions on
  30 the website.
  31
  32 If you think the snippet is particularly informative and you think
  33 it should be included in the documentation, tag it with "docs" and
  34 one or more other categories.
  35
  36 Please make sure that the lilypond code follows the guidelines in
  37 @ref{LilyPond formatting}.
  38
  39
  40 @node Approving snippets
  41 @section Approving snippets
  42
  43 The main task of LSR editors are approving snippets.  Log in to
  44 @uref{http://lsr.dsi.unimi.it/, LSR} and find a list of unapproved
  45 snippets by
  46 FIXME DOING SOMETHING.
  47
  48 Check each snippet:
  49
  50 @enumerate
  51
  52 @item
  53 Does the snippet make sense and does what the author claims that
  54 it does?  If you think the snippet is particularly helpful, add
  55 the "docs" tag and at least one other tag.
  56
  57 @item
  58 If the snippet is tagged with "docs", check to see if it matches
  59 our guidelines for @ref{LilyPond formatting}.
  60
  61 @item
  62 If the snippet uses scheme, check that everything looks good and
  63 there are no security risks.
  64
  65 @warning{Somebody could sneak a @code{#'(system "rm -rf /")}
  66 command into our source tree if you do not do this!  Take this
  67 step @strong{VERY SERIOUSLY}.}
  68
  69 @end enumerate
  70
  71
  72 @node LSR to git
  73 @section LSR to git
  74
  75 FIXME: Neil, please check that this is up-to-date.
  76
  77 @enumerate
  78
  79 @item
  80 Download the latest tarball from
  81 @uref{http://lsr.dsi.unimi.it/download/}.  You want a file called
  82 @file{lsr-snippets-docs-DATE.tar.gz}.
  83
  84 @item
  85 From the top source directory, run:
  86
  87 @example
  88 scripts/auxiliar/makelsr.py
  89 @end example
  90
  91 @item
  92 Follow the instructions on the console to manually check for
  93 unsafe files.
  94
  95 @warning{Somebody could sneak a @code{#'(system "rm -rf /")}
  96 command into our source tree if you do not do this!  Take this
  97 step @strong{VERY SERIOUSLY}.}
  98
  99 @item
 100 Do a git add / commit / push.
 101
 102 @end enumerate
 103