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