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 <h3>Source code</h3>
  54
  55 The website and upload client are maintained at
  56 <a href="https://gitlab.com/yarrg"><kbd>https://gitlab.com/yarrg</kbd></a>.
  57
  58 <kbd>git clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/</kbd><br>
  59 obtains the source code of the latest version released for use as a
  60 screenscraper client, which you can also find
  61 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as
  62 an unpacked tree</a>
  63
  64 <p><a href="source.tar.gz">Live website source code</a> can
  65 be downloaded:  In case we have made changes but not yet pushed them
  66 (perhaps because we haven't done a release), and to make it easy for
  67 anyone else who runs a copy of the website to provide everyone with
  68 the source for their version, the website code itself lets you download
  69 an up-to-date of its actually-running source code.  So this link
  70 gives you the source code for the pages you are now looking at.
  71
  72 <p>All of the above trees are available via the
  73 <a href="http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git">gitweb
  74 source code and history browser</a>.
  75
  76 <h4>Uploader</h4>
  77
  78 The uploader is also Free Software, but under a slightly different
  79 licence.  The <a href="upload">uploader page</a> has
  80 <a href="upload#source">complete information on how to get its source code</a>.
  81
  82 <h3>YARRG website code instances</h3>
  83
  84 <h4>Lookup website</h4>
  85  <ul>
  86  <li><a href="http://yarrg.chiark.net/">Main released site</a>,
  87      with <a href="http://yarrg.chiark.net/source.tar.gz">source code</a> (and
  88    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-live.git">committed changes via git</a>)
  89  <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a> (source code as above)
  90  <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>,
  91      with <a href="http://yarrg.chiark.net/test/code/source.tar.gz">source code</a> (and
  92    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-test.git">committed changes via git</a>)
  93  <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a> (source code as above)
  94  </ul>
  95
  96 <p>
  97
  98 You can add the form parameter <kbd>?debug=1</kbd> to each of the
  99 website URLs above to get a version of the site with debugging output enabled.
 100
 101 <h4>Database and dictionary update receiver</h4>
 102
 103 On the live system there are different trees, potentially with
 104 different versions, for receiving updates and managing the database,
 105 to the ones for displaying the website.  The database management trees
 106 are normally accessed only via the upload client but you may also
 107 download their source directly:
 108
 109  <ul>
 110  <li><a href="http://upload.yarrg.chiark.net/commod-update-receiver?get_source=1">Main production instance</a> including uncommitted changes; or
 111    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-live.git">committed changes via git</a>
 112  <li><a href="http://upload.yarrg.chiark.net/test/commod-update-receiver?get_source=1">Testing database instance</a> including uncommitted changes; or
 113    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-test.git">committed changes via git</a>
 114  </ul>
 115
 116 <h3>Data</h3>
 117
 118 <kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
 119 accesses files published for the benefit of the old yarrg upload client
 120 and other members of the ypp-sc-tools family.
 121
 122 <p>
 123
 124 This directory also contains slightly stale copies (updated daily)
 125 of the actual databases (in SQLite3 format).
 126 It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
 127 but please do not repeatedly download the databases by http - use
 128 rsync which is much more efficient.  Note also that if you want to
 129 actually run your own improved yarrg website, I can arrange to
 130 feed you data in real time - see below.
 131
 132 <p>
 133
 134 <kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
 135 accesses the data for the testing instance.
 136
 137 <h3>Documentation</h3>
 138
 139 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
 140 has the specification of the mechanism and format for uploading to YARRG.
 141
 142 <h2>Support from the YARRG team</h2>
 143
 144 If you would like to run a (perhaps modified) copy of the YARRG
 145 website it would be very easy for us to make our system send you
 146 copies of updates submitted by users of the YARRG clients including
 147 JARRG, in the format expected by the YARRG code.  Please just
 148 ask us - at our end it's just a matter of us adding your database
 149 instance's special email address to our alias file.
 150
 151 <p>
 152
 153 We encourage the development and improvement of this code.  Please
 154 continue to share your improvements with the Puzzle Pirates community.
 155 In particular, do not remove or break the feature that allows users of
 156 your website to download the up to date code you are running.
 157
 158 <h2>Contacting the YARRG developers</h2>
 159
 160 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
 161 any Fleet Officer or above of the crew Special Circumstances on the
 162 Cerulean Ocean.
 163
 164 <p>
 165 </div>
 166 <& footer, isdevel => 1 &>