expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2025-12-08 14:54:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify handbook/update.htm on server-side checkins, and non-DVCS files.

Browse Source 
reflow some very long lines.
This commit is contained in:
Wookey
2017-08-19 00:59:32 +01:00
parent 9b52f8c5d7
commit 194bed100f
1 changed files with 43 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
handbook/update.htm
View File

@@ -21,17 +21,46 @@
<p>Simple <a href="checkin.htm">instructions</a> for updating the website
(on the expo machine).</p>
<p>You can update the site via the troggle pages, by editing pages online via a browser ("Edit this page" on the menu on the left), by editing them locally on disk, or by checking out the relevant part to your computer and editing it there. Which is best depends on your knowledge and what you want to do. For simple addition of cave or survey data troggle is recommended. For other edits it's best if you can edit the files directly rather than using the 'edit this page' button, but that means you either need to be on expo with the expo computer, or be able to check out a local copy. If neither of these apply then using the 'edit this page' button is fine.</p>
<p>You can update the site via the troggle pages, by editing pages
online via a browser ("Edit this page" on the menu on the left), by
editing them locally on disk, or by checking out the relevant part to
your computer and editing it there. Which is best depends on your
knowledge and what you want to do. For simple addition of cave or
survey data troggle is recommended. For other edits it's best if you
can edit the files directly rather than using the 'edit this page'
button, but that means you either need to be on expo with the expo
computer, or be able to check out a local copy. If neither of these
apply then using the 'edit this page' button is fine.</p>
<p>It's important to understand that everything on the site is stored in a distributed version control system (DVCS) (called '<a href=#mercurial>Mercurial</a>' and accessed by most people using software called 'TortoiseHg'), which means that every edited file needs to be 'checked in' at some point. The Expo website manual goes into more detail about this, below. This stops us losing data and makes it very hard for you to screw anything up permanently, so don't worry about making changes - they can always be reverted if there is a problem. It also means that several people can work on the site on different computers at once and normally merge their changes easily.</p>
<p>It's important to understand that everything on the site (except
'expofiles') is stored in a distributed version control system (DVCS)
(called '<a href=#mercurial>Mercurial</a>' and accessed by most people
using software called 'TortoiseHg'), which means that every edited
file needs to be 'checked in' at some point. The Expo website manual
goes into more detail about this, below. This stops us losing data and
makes it very hard for you to screw anything up permanently, so don't
worry about making changes - they can always be reverted if there is a
problem. It also means that several people can work on the site on
different computers at once and normally merge their changes
easily.</p>
<p>Increasing amounts of the site are autogenerated, not just files, so you have to edit the base data, not the generated file. All autogenerated files say 'This file is autogenerated - do not edit' at the top - so check for that before wasting time on changes that will just be overwritten</p>
<p>Increasing amounts of the site are autogenerated, not just files,
so you have to edit the base data, not the generated file. All
autogenerated files say 'This file is autogenerated - do not edit' at
the top - so check for that before wasting time on changes that will
just be overwritten</p>
<h2>Expo website manual</h2>
<p>Editing the expo website is an adventure. Until now, there was no guide which explains the whole thing as a functioning system. Learning it by trial and error is non-trivial. There are lots of things we could improve about the system, and anyone with some computer nous is very welcome to muck in. It is slowly getting better organised.</p>
<p>Editing the expo website is an adventure. Until now, there was no
guide which explains the whole thing as a functioning system. Learning
it by trial and error is non-trivial. There are lots of things we
could improve about the system, and anyone with some computer nous is
very welcome to muck in. It is slowly getting better organised.</p>
<p>This manual is organized in a how-to sort of style. The categories, rather than referring to specific elements of the website, refer to processes that a maintainer would want to do.</p>
<p>This manual is organized in a how-to sort of style. The categories,
rather than referring to specific elements of the website, refer to
processes that a maintainer would want to do.</p>
<h3>Contents</h3>
@@ -73,12 +102,13 @@ expo.survex.com. This is currently hosted on a server at the university. Mercuri
<li>expoweb - the website itself, including generation scripts</li>
<li>troggle - the database-driven part of the website</li>
<li>loser - the survex survey data</li>
<li>tunneldata - the tunnel data and drawings</li>
<li>tunneldata - the tunnel (and therion) data and drawings</li>
</ul>
<p>All the scans, photos, presentations, fat documents and videos are
stored just as files (not in version control). See below for details on that.</p>
stored just as files (not in version control) in 'expofiles'. See
below for details on that.</p>
<h3><a id="howitworks">How the website works</a></h3>
@@ -180,7 +210,12 @@ then restart nautilus <tt>nautilus -q</tt>. If it works, you'll be able to see t
<p>Simple changes to static files will take effect immediately, but changes to dynamically-generated files (cave descriptions, QM lists etc) will not take effect, until the server runs the expoweb-update script.</p>
<h3><a id="editthispage">Using 'Edit This Page'</a></h3>
<p>This edits the file served by the webserver (Apache) on expo.survex.com but it does not update the copy of the file in the repository in expo.survex.com. To properly finish the job you need to use putty to ssh into expo.survex.com and run "hg diff" and then "hg commit" and "hg fetch" in the directory /home/expo/expoweb .</p>
<p>This edits the file served by the webserver (Apache) on
expo.survex.com but it does not update the copy of the file in the
repository in expo.survex.com. To properly finish the job you need to
use putty to ssh into expo.survex.com and run "hg diff" (to check what
changes are pending) and then "hg commit" in the directory
/home/expo/expoweb .</p>
<h3><a id="Mercurialinwindows">Using Mercurial/TortoiseHg in Windows</a></h3>