</%doc>
-<html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
-</head><body>
-
-<a href="lookup">YARRG</a> -
- Yet Another Revenue Research Gatherer
-|
-<b>development</b>
-|
-<a href="intro">introduction</a>
-|
-<a href="docs">documentation</a>
-
+<& docshead &>
<h1>YARRG development, contribution and troubleshooting</h1>
<h2>Free Software (aka Open Source) licensing</h2>
YARRG is Free Software - you may share and modify it. See the
licences for details. Not only the client but also the website code
-is Free. The yarrg client, support files, and so forth are under
-the GNU GPL (v3 or later); the website is under the GNU Affero GPL (v3
-or later). </p>
+is Free. The yarrg client, support files, and so forth are under the
+GNU GPL (v3 or later); the website and database backend is under the
+GNU Affero GPL (v3 or later).
<p>
<h3>Source code</h3>
-<kbd>git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/</kbd><br>
+<kbd>git clone git://git.yarrg.chiark.net/ypp-sc-tools.main.git</kbd><br>
+clones the master tree through which we push most changes.
+<p>
+
+<kbd>git clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/</kbd><br>
obtains the source code of the latest version released for use as a
-client, which you can also find
+screenscraper client, which you can also find
<a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as
an unpacked tree</a>
<p><a href="source.tar.gz">Live website source code</a> can
-be downloaded, in case we have made changes but not yet pushed them
+be downloaded: In case we have made changes but not yet pushed them
(perhaps because we haven't done a release), and to make it easy for
anyone else who runs a copy of the website to provide everyone with
the source for their version, the website code itself lets you download
an up-to-date of its actually-running source code. So this link
gives you the source code for the pages you are now looking at.
-<h3>YARRG lookup website instances</h3>
+<p>All of the above trees are available via the
+<a href="http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git">gitweb
+source code and history browser</a>.
+
+<h4>Uploader</h4>
+
+The uploader is also Free Software, but under a slightly different
+licence. The <a href="upload">uploader page</a> has
+<a href="upload#source">complete information on how to get its source code</a>.
+
+<h3>YARRG website code instances</h3>
+
+<h4>Lookup website</h4>
<ul>
- <li><a href="http://yarrg.chiark.net/">Main released site</a>
- <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a>
- <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>
- <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a>
+ <li><a href="http://yarrg.chiark.net/">Main released site</a>,
+ with <a href="http://yarrg.chiark.net/source.tar.gz">source code</a> (and
+ <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-live.git">committed changes via git</a>)
+ <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a> (source code as above)
+ <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>,
+ with <a href="http://yarrg.chiark.net/test/code/source.tar.gz">source code</a> (and
+ <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-test.git">committed changes via git</a>)
+ <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a> (source code as above)
</ul>
-Each of these allows you to download its own source code so you
-can get both the testing and the main version of the website.
+<p>
+
+You can add the form parameter <kbd>?debug=1</kbd> to each of the
+website URLs above to get a version of the site with debugging output enabled.
+
+<h4>Database and dictionary update receiver</h4>
+
+On the live system there are different trees, potentially with
+different versions, for receiving updates and managing the database,
+to the ones for displaying the website. The database management trees
+are normally accessed only via the upload client but you may also
+download their source directly:
+
+ <ul>
+ <li><a href="http://upload.yarrg.chiark.net/commod-update-receiver?get_source=1">Main production instance</a> including uncommitted changes; or
+ <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-live.git">committed changes via git</a>
+ <li><a href="http://upload.yarrg.chiark.net/test/commod-update-receiver?get_source=1">Testing database instance</a> including uncommitted changes; or
+ <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-test.git">committed changes via git</a>
+ </ul>
<h3>Data</h3>
<kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
-accesses files published for the benefit of the yarrg upload client,
+accesses files published for the benefit of the old yarrg upload client
+and other members of the ypp-sc-tools family.
<p>
If you would like to run a (perhaps modified) copy of the YARRG
website it would be very easy for us to make our system send you
-copies of updates submitted by users of the official YARRG client, in
-the format expected by the YARRG code. Please just ask us - it's just
-a matter of us adding your database instance's special email address
-to our alias file.
+copies of updates submitted by users of the YARRG clients including
+JARRG, in the format expected by the YARRG code. Please just
+ask us - at our end it's just a matter of us adding your database
+instance's special email address to our alias file.
<p>
any Fleet Officer or above of the crew Special Circumstances on the
Midnight Ocean.
+<p>
+</div>
<& footer, isdevel => 1 &>
~yarrgweb / ypp-sc-tools.web-live.git / blobdiff