working on the mess that is several unfinished bit of computing manual

This commit is contained in:
Philip Sargent 2019-12-27 20:35:00 +00:00
parent 4fe03e4a61
commit f83edf27a0
6 changed files with 56 additions and 35 deletions

View File

@ -10,14 +10,34 @@
<h1>Setting up an Expo laptop - using Microsoft Windows</h1>
<p>A work in progress...
<p>A work in progress.
<p>It used to be quite simple - software equivalents existed for Windows for everything we needed. The new (since Spring 2018) requirement to make ssh keys obligatory has simply added an extra step for most things, but has made one thing (rsync) really quite hard to get working.
<ul>
<li><a href="#well">Things that already work well with a Windows laptop</a><br>
- Editing the handbook webpages, typing up SVX files and transcribing the logbook, <br>
- Anything where the file-transfer to the expo surver is via the version control software (TortoiseHg or Git-for-Windows)
<li><a href="#problems">Things that cause problems</a><br>
- filenames and unintentional duplication because hardlinks are not understood by Windows,<br>
- sFTP or scp for more than a handful of files
<li><a href="#hard">Things that are really, really hard</a><br>
- using rsync <br>
- large-scale updating of several folders at once on expofiles without overwriting other people's work (which means using rsync)
</ul>
<h3>Things that already work well</h3>
<h3>Things that cause problems</h3>
<h3>Things that are really, really hard</h3>
<h3 id="well">Things that already work well</h3>
<p>Anytihng to
<h3 id="problems">Things that cause problems</h3>
<p>Linux people like to use hard-links: where there is really only one file, but it is referred to by different names. The ones you are most likely to come across are that what looks like
/home/expo/expoweb is really just a link to /home/expo/repositories/hg/expoweb, and that
expoweb/essentials.gpx
is a link to /home/expo/expofiles/gpslogs/essentials/essentials2019.gpx
<h3 id="hard">Things that are really, really hard</h3>
<p>The core problem is integrating the PuTTy key management software (pagent.exe) with a terminal window.
<hr />
<p>WSL: the Windows Subsystem for Linux. The first release of this didn't do the ssh key exchange process easily. The 2019 WSL2 release includes a complete Linux kernel. If you want to use this, then please do - and then write the handbook documentation too. But beware that it has two different modes which behave differently.
<div id="menu">
<ul id="links">
<li><a href="../index.htm">Handbook</a>

View File

@ -28,10 +28,13 @@ rather than referring to specific elements of the data management system, refer
processes that a maintainer would want to do.</p>
<p>Note that to display the survey data you will need a copy of the <a href="getsurvex.html">survex</a> software.
<p>Go elsewhere if this is what you want to know:
<p>Follow these links if you have reached this page by accident and this is what you want to know:
<ul>
<li><a href="uploading.html">How to upload photos</a></li>
<li><a href="logbooks.html">Typing in logbook entries</a></li>
<li><a href="gpxupload.html">Recording the GPS location of a cave</a></li>
<li><a href="survey/index.htm">How to do cave surveying</a></li>
<li><a href="index.htm">List of "How to" pages for everything else</a></li>
</ul>
<h3>Contents of this manual</h3>
@ -46,7 +49,6 @@ processes that a maintainer would want to do.</p>
<li><a href="#expowebupdate">The expoweb-update script</a></li>
<li><a href="#cavepages">Updating cave pages</a></li>
<li><a href="#updatingyears">Updating expo year pages</a></li>
<li><a href="#tickingoff">Ticking off QMs</a></li>
<li><a href="#surveystatus">Maintaining the survey status table</a></li>
<li><a href="#automation">Automation</a></li>
@ -85,10 +87,10 @@ editing and keeps track of all changes so we can roll back and have branches if
<p>The site has been split into four parts:</p>
<ul>
<li><a href="/repositories/home/expo/loser/graph/">loser</a> - the survex cave survey data</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings</li>
<li><a href="/repositories/home/expo/expoweb/graph">expoweb</a> - the website pages, handbook, generation scripts</li>
<li><a href="/cgit/troggle/.git/log">troggle</a> - the database/software part of the survey data management system - see <a href="computing/troggle-ish.html">notes on troggle</a> for further explanation</li>
<li><a href="/repositories/home/expo/loser/graph/">loser</a> - the survex cave survey data (hg)</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/repositories/home/expo/expoweb/graph">expoweb</a> - the website pages, handbook, generation scripts (hg)</li>
<li><a href="/cgit/troggle/.git/log">troggle</a> - the database/software part of the survey data management system - see <a href="computing/troggle-ish.html">notes on troggle</a> for further explanation (git)</li>
</ul>
<p>We have migrated two of these to git but the other two still use mercurial.
@ -106,10 +108,10 @@ below for details on that.</p>
<p>Examples of troggle-generated pages from data:
<ul>
<li><a href="http://expo.survex.com/caves">expo.survex.com/caves</a> - list of caves surveyed and links to guidebook descriptions
<li><a href="http://expo.survex.com/pubs.htm">http://expo.survex.com/pubs.htm</a> - reports, accounts and logbooks
<li><a href="http://expo.survex.com/pubs.htm">expo.survex.com/pubs.htm</a> - reports, accounts and logbooks
<li><a href="http://expo.survex.com/expedition/2018">expo.survex.com/expedition/2018</a> - Members on expo 2018: . Scroll down for a list of all the data typed in from survey trips.
<li><a href="http://expo.survex.com/survexfile/caves/">expo.survex.com/survexfile/caves/</a> - List of caves with all the surveys done for each.
<li><a href="http://expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx">expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx</a> - Cave survey data from 1983 in Schnellzughohle.
<li><a href="http://expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx">expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx</a> - CUCC cave survey data from 1983 in Schnellzughohle.
<li><a href="http://expo.survex.com/survey_scans/">expo.survex.com/survey_scans/</a> - List of all scanned original survey notes.
<li><a href="http://expo.survex.com/survey_scans/2018%252343/">expo.survex.com/survey_scans/2018%252343/</a> - list of links to scanned notes for wallet #43 during the 2018 expo.
</ul>
@ -121,7 +123,7 @@ See 'The expoweb-update script' below for details.</p>
<p>Also note that the ::expoweb:: web pages and cave data reports you see on the visible website
are not the same as the version-controlled "master" expoweb repo.
So in order that your committed and pushed changes become visible on the website,
they have to be 'pulled' from the repo onto the webserver before your changes are reflected.</p>
they have to be 'pulled' from the repo (on teh server machine) onto the webserver (another place on the same server machine) before your changes are reflected.</p>
<h3><a id="yourownlaptop">Your own laptop</a></h3>
<p>Setting your own laptop so that it can do everything the <i>expo laptop</i> can do is quite a
@ -254,9 +256,9 @@ superseded in 2012).</p>
<p>Each year's expo has a documentation index which is in the folder</p>
<p>/expoweb/years</tt></p>
<tt>/expoweb/years</tt>
<p>, so to checkout the 2011 page, for example, you would use</p>
<p>so to checkout the 2011 page, for example, you would use</p>
<p>hg clone ssh://expo@expo.survex.com/expoweb/years/2011</tt></p>
@ -275,10 +277,6 @@ a lot better, but some way to make sure that names match with previous
years would be
good.</p>
<h3><a id="tickingoff">Ticking off QMs</a></h3>
<p>To be written.</p>
<h3><a id="surveystatus">Maintaining the survey status table</a></h3>

View File

@ -121,7 +121,7 @@ and publish it on the web.
<p>Examples of troggle-generated pages from data:
<ul>
<li><a href="http://expo.survex.com/caves">expo.survex.com/caves</a> - list of caves surveyed and links to guidebook descriptions
<li>< href="http://expo.survex.com/pubs.htm">http://expo.survex.com/pubs.htm</a> - reports, accounts and logbooks
<li><a href="http://expo.survex.com/pubs.htm">expo.survex.com/pubs.htm</a> - reports, accounts and logbooks
<li><a href="http://expo.survex.com/expedition/2018">expo.survex.com/expedition/2018</a> - Members on expo 2018: . Scroll down for a list of all the data typed in from survey trips.
<li><a href="http://expo.survex.com/survexfile/caves/">expo.survex.com/survexfile/caves/</a> - List of caves with all the surveys done for each.
<li><a href="http://expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx">expo.survex.com/survexfile/caves-1623/115/cucc/futility.svx</a> - Cave survey data from 1983 in Schnellzughohle.

View File

@ -197,6 +197,8 @@ loser "caves-1623/264/mongolrally.svx". We are assuming that normal users have n
worked with an distributed version control system at this point whcih is why we are only
telling them to use the <em>expo laptop</em>.]
<h3><a id="tickingoff">Ticking off QMs</a></h3>
<p>To be written.</p>
<h3 id="runsurvex">Running survex to create a centre-line</h3>
<p><em>to be documented</em>
@ -207,11 +209,11 @@ telling them to use the <em>expo laptop</em>.]
<p><em>to be documented</em> See <a href="drawup.htm">drawing up the sketches</a>.
<p>The files of your scanned and re-scanned sketches should be stored in the same folder
as the scanned notes, i.e. (for wallet #19) you would put them in:
<pre>
<tt>
/home/expo/expofiles/surveyscans/2018/2018#19/
</pre>
</tt>
<h3>Using tunnel (or therion) for final survey production</h3>
<h3>Using tunnel or therion for final survey production</h3>
<p><em>to be documented</em>
<ul>
<li><a href="/expofiles/tunnelwiki/wiki/pages/Tunnel.html">Tunnel tutorial</a> - a wiki of examples and tutorials
@ -220,7 +222,7 @@ as the scanned notes, i.e. (for wallet #19) you would put them in:
<p>Tunnel only produces plan surveys, but they are very pretty.
<p>The tunnel (or therion) files should NOT stored in the same folder as the scanned notes. They should
be uploaded to the version control repository //tunneldata//.
be uploaded to the version control repository <span style="font-family:monospace; size=x-small; background-color: lightgray"><a href="http://expo.survex.com/cgit/drawings/.git/log">drawings</a></span>,
<h3>Interim rigging guide</h3>
<p>The logbook is the place where we record the rigging of caves as we discover them.
@ -265,6 +267,8 @@ ensure that all bolts can be found again and any deviations and natural belays r
<p><em>to be completed</em>
<hr />
<ul id="links">

View File

@ -1,3 +1,4 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
@ -81,11 +82,11 @@ If you want to update the handbook or other parts of the website you will also n
You can scan what's in the repositories (read only) using your web browser:
<ul>
<li><a href="http://expo.survex.com/repositories/home/expo/loser/graph/">loser</a> - the survex survey data</li>
<li><a href="http://expo.survex.com/repositories/home/expo/expoweb/graph">expoweb</a> - the website itself, including generation scripts</li>
<li><a href="http://expo.survex.com/repositories/home/expo/tunneldata/graph/">tunneldata</a> - the tunnel (and therion) data and drawings</li>
<li><a href="http://expo.survex.com/repositories/home/expo/troggle/graph/">troggle</a> - the database-driven part of the website - see <a href="../troggle-ish.html">troggle description</a></li>
</ul>
<li><a href="/repositories/home/expo/loser/graph/">loser</a> - the survex cave survey data (hg)</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/repositories/home/expo/expoweb/graph">expoweb</a> - the website pages, handbook, generation scripts (hg)</li>
<li><a href="/cgit/troggle/.git/log">troggle</a> - the database/software part of the survey data management system - see <a href="computing/troggle-ish.html">notes on troggle</a> for further explanation (git)</li>
</ul>>
<p>If anything seems unclear, please email me at elmo2058@gmail.com, and I will reinstall things

View File

@ -136,13 +136,12 @@ university since Feb 2014.
<p>In 2018 we have 4 repositories,
<ul>
<li><a href="http://expo.survex.com/repositories/home/expo/expoweb/graph">expoweb</a> - the handbook and data management system webpages, including generation scripts</li>
<li><a href="http://expo.survex.com/repositories/home/expo/troggle/graph/">troggle</a> - the database-driven part of the data management system - see <a href="computing/troggle-ish.html">notes on troggle</a> for further explanation</li>
<li><a href="http://expo.survex.com/repositories/home/expo/loser/graph/">loser</a> - the survex survey data</li>
<li><a href="http://expo.survex.com/repositories/home/expo/tunneldata/graph/">tunneldata</a> - the tunnel (and therion) data and drawings</li>
<li><a href="/repositories/home/expo/loser/graph/">loser</a> - the survex cave survey data (hg)</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/repositories/home/expo/expoweb/graph">expoweb</a> - the website pages, handbook, generation scripts (hg)</li>
<li><a href="/cgit/troggle/.git/log">troggle</a> - the database/software part of the survey data management system - see <a href="computing/troggle-ish.html">notes on troggle</a> for further explanation (git)</li>
</ul>
<p>In spring 2018 Sam, Wookey and Paul Fox updated the Linux version and the Django version (i.e. troggle) to
something vaguely acceptable to the university computing service and fixed all the problems that were then observed.
@ -206,7 +205,6 @@ Before then we manually maintained <a href="../update.htm">a list of updates</a>
Return to<br>
<a href="onlinesystems.html">Website update</a><br>
<a href="expodata.html">Website developer information</a><br>
<hr>
</body>