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 is approving snippets.  To find a list of
  44 unapproved snippets, log into @uref{http://lsr.dsi.unimi.it/, LSR} and
  45 select @qq{No} from the dropdown menu to the right of the word
  46 @qq{Approved} at the bottom of the interface, then click
  47 @qq{Enable filter}.
  48
  49 Check each snippet:
  50
  51 @enumerate
  52
  53 @item
  54 Does the snippet make sense and does what the author claims that
  55 it does?  If you think the snippet is particularly helpful, add
  56 the "docs" tag and at least one other tag.
  57
  58 @item
  59 If the snippet is tagged with "docs", check to see if it matches
  60 our guidelines for @ref{LilyPond formatting}.
  61
  62 @item
  63 If the snippet uses scheme, check that everything looks good and
  64 there are no security risks.
  65
  66 @warning{Somebody could sneak a @code{#'(system "rm -rf /")}
  67 command into our source tree if you do not do this!  Take this
  68 step @strong{VERY SERIOUSLY}.}
  69
  70 @end enumerate
  71
  72
  73 @node LSR to git
  74 @section LSR to git
  75
  76 FIXME: Neil, please check that this is up-to-date.
  77
  78 @enumerate
  79
  80 @item
  81 Download the latest tarball from
  82 @uref{http://lsr.dsi.unimi.it/download/}.  You want a file called
  83 @file{lsr-snippets-docs-DATE.tar.gz}.
  84
  85 @item
  86 From the top source directory, run:
  87
  88 @example
  89 scripts/auxiliar/makelsr.py
  90 @end example
  91
  92 @item
  93 Follow the instructions on the console to manually check for
  94 unsafe files.
  95
  96 @warning{Somebody could sneak a @code{#'(system "rm -rf /")}
  97 command into our source tree if you do not do this!  Take this
  98 step @strong{VERY SERIOUSLY}.}
  99
 100 @item
 101 Do a git add / commit / push.
 102
 103 @end enumerate
 104