yarrg/web/devel

   1 <%doc>
   2
   3  This is part of the YARRG website.  YARRG is a tool and website
   4  for assisting players of Yohoho Puzzle Pirates.
   5
   6  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   7  Copyright (C) 2009 Clare Boothby
   8
   9   YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
  10   The YARRG website is covered by the GNU Affero GPL v3 or later, which
  11    basically means that every installation of the website will let you
  12    download the source.
  13
  14  This program is free software: you can redistribute it and/or modify
  15  it under the terms of the GNU Affero General Public License as
  16  published by the Free Software Foundation, either version 3 of the
  17  License, or (at your option) any later version.
  18
  19  This program is distributed in the hope that it will be useful,
  20  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  GNU Affero General Public License for more details.
  23
  24  You should have received a copy of the GNU Affero General Public License
  25  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  28  are used without permission.  This program is not endorsed or
  29  sponsored by Three Rings.
  30
  31
  32  This Mason component generates the introduction.
  33
  34
  35 </%doc>
  36 <& docshead &>
  37 <h1>YARRG development, contribution and troubleshooting</h1>
  38
  39 <h2>Free Software (aka Open Source) licensing</h2>
  40
  41 YARRG is Free Software - you may share and modify it.  See the
  42 licences for details.  Not only the client but also the website code
  43 is Free.  The yarrg client, support files, and so forth are under the
  44 GNU GPL (v3 or later); the website and database backend is under the
  45 GNU Affero GPL (v3 or later).
  46
  47 <p>
  48
  49 Note that there is <strong>NO WARRANTY</strong> !
  50
  51 <h2>Resources for developers</h2>
  52
  53 For information about the YARRG JPCTB uploader, see the
  54 <a href="upload">page about the uploader</a>.
  55
  56 <h3>Source code</h3>
  57
  58 <kbd>git clone git://git.yarrg.chiark.net/ypp-sc-tools.main.git</kbd><br>
  59 clones the master tree through which we push most changes.
  60 <p>
  61
  62 <kbd>git clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/</kbd><br>
  63 obtains the source code of the latest version released for use as a
  64 screenscraper client, which you can also find
  65 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as
  66 an unpacked tree</a>
  67
  68 <p><a href="source.tar.gz">Live website source code</a> can
  69 be downloaded:  In case we have made changes but not yet pushed them
  70 (perhaps because we haven't done a release), and to make it easy for
  71 anyone else who runs a copy of the website to provide everyone with
  72 the source for their version, the website code itself lets you download
  73 an up-to-date of its actually-running source code.  So this link
  74 gives you the source code for the pages you are now looking at.
  75
  76 <h3>YARRG website code instances</h3>
  77
  78 <h4>Lookup website</h4>
  79  <ul>
  80  <li><a href="http://yarrg.chiark.net/">Main released site</a>,
  81      with <a href="http://yarrg.chiark.net/source.tar.gz">source code</a> (and
  82    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-live.git">committed changes via git</a>)
  83  <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a> (source code as above)
  84  <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>,
  85      with <a href="http://yarrg.chiark.net/test/code/source.tar.gz">source code</a> (and
  86    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-test.git">committed changes via git</a>)
  87  <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a> (source code as above)
  88  </ul>
  89
  90 <p>
  91
  92 You can add the form parameter <kbd>?debug=1</kbd> to each of the
  93 website URLs above to get a version of the site with debugging output enabled.
  94
  95 <h4>Database and dictionary update receiver</h4>
  96
  97 On the live system there are different trees, potentially with
  98 different versions, for receiving updates and managing the database,
  99 to the ones for displaying the website.  The database management trees
 100 are normally accessed only via the upload client but you may also
 101 download their source directly:
 102
 103  <ul>
 104  <li><a href="http://upload.yarrg.chiark.net/commod-update-receiver?get_source=1">Main production instance</a> including uncommitted changes; or
 105    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-live.git">committed changes via git</a>
 106  <li><a href="http://upload.yarrg.chiark.net/test/commod-update-receiver?get_source=1">Testing database instance</a> including uncommitted changes; or
 107    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-test.git">committed changes via git</a>
 108  </ul>
 109
 110 <h3>Data</h3>
 111
 112 <kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
 113 accesses files published for the benefit of the yarrg upload client,
 114
 115 <p>
 116
 117 This directory also contains slightly stale copies (updated daily)
 118 of the actual databases (in SQLite3 format).
 119 It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
 120 but please do not repeatedly download the databases by http - use
 121 rsync which is much more efficient.  Note also that if you want to
 122 actually run your own improved yarrg website, I can arrange to
 123 feed you data in real time - see below.
 124
 125 <p>
 126
 127 <kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
 128 accesses the data for the testing instance.
 129
 130 <h3>Documentation</h3>
 131
 132 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
 133 has the specification of the mechanism and format for uploading to YARRG.
 134
 135 <h2>Support from the YARRG team</h2>
 136
 137 If you would like to run a (perhaps modified) copy of the YARRG
 138 website it would be very easy for us to make our system send you
 139 copies of updates submitted by users of the official YARRG client, in
 140 the format expected by the YARRG code.  Please just ask us - at our
 141 end it's just a matter of us adding your database instance's special
 142 email address to our alias file.
 143
 144 <p>
 145
 146 We encourage the development and improvement of this code.  Please
 147 continue to share your improvements with the Puzzle Pirates community.
 148 In particular, do not remove or break the feature that allows users of
 149 your website to download the up to date code you are running.
 150
 151 <h2>Contacting the YARRG developers</h2>
 152
 153 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
 154 any Fleet Officer or above of the crew Special Circumstances on the
 155 Midnight Ocean.
 156
 157 <p>
 158 </div>
 159 <& footer, isdevel => 1 &>