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