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

All links to repos now go to new page

Browse Source
This commit is contained in:
Philip Sargent
2020-04-26 21:41:21 +01:00
parent 615ce571c4
commit 6702081779
26 changed files with 92 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
handbook/computing/basiclaptop.html
View File

@@ -16,7 +16,7 @@
<ol>
<li>Register an SSH key</a> with an expo nerd i.e 'get a login'. (see "Key Configuration" below)</li>
<li>Install <a href="#software">git version control software</a> to download ("clone"), view and edit caving data.</li>
<li>Clone three <a href="manual.html#repositories">expo repositories</a> <var>loser, drawings</var> and <var>expoweb</var> so you have the files on your machine. (Use the <a href="qstart-git.html">git reminder</a> for how to do this, e.g. <em>git clone ssh://expo@expo.survex.com:/home/expo/expoweb</em></li>
<li>Clone three <a href="../computing/repos.html">expo repositories</a> <var>loser, drawings</var> and <var>expoweb</var> so you have the files on your machine. (Use the <a href="qstart-git.html">git reminder</a> for how to do this, e.g. <em>git clone ssh://expo@expo.survex.com:/home/expo/expoweb</em></li>
<li>Install survex, and therion or tunnel for editing cave data.
</ol>

2
handbook/computing/exposerver.html
View File

@@ -15,7 +15,7 @@
<p>We interact with it using:
<ul>
<li>git - for the git
<a href="../../repositories">repositories</a> expoweb, loser, drawings, tunnel.
<<a href="../computing/repos.html">repositories</a> expoweb, loser, drawings, tunnel.
<li>sFTP and rsync - mostly for uploading to /expofiles/
<li>ssh - occasionally, by experts,to fix things when something goes wrong or for major site reconfiguration.
</ul>

2
handbook/computing/folkupdate.html
View File

@@ -13,7 +13,7 @@
<h3 id="import">The folk list</a></h3>
<p>This is part of the <a href="newyear.html">"new expo year"</a> preparations.
The folk.csv file is stored on the server under version control in the :expoweb: repository in
The folk.csv file is stored on the server under version control in the <var>:expoweb:</var> <a href="../computing/repos.html">repository</a> in
<code>expoweb/folk/folk.csv</code>
<p>Before expo starts the folk.csv file is updated.

2
handbook/computing/hbmanual1.html
View File

@@ -93,7 +93,7 @@ t/ - a thumbnail image which is usually used inside an &lt;a&gt; tag to link to
<hr />
<h3 id="tidy">Tidying up and commiting the edits</h3>
<p>'Edit This Page' edits the file served on the web but it does not update the file in the version control
repository. To properly finish the job you need to get a nerd to
<a href="../computing/repos.html">repository</a>. To properly finish the job you need to get a nerd to
<ul>
<li>
ssh into expo@expo.survex.com from a machine already configured to do this

7
handbook/computing/hbmanual2.html
View File

@@ -14,7 +14,7 @@
<p>These pages are for cavers wanting to:
<ol>
<li>quickly edit a correction using "<a href="hbmanual1.html">Edit this page</a>", or
<li>edit several pages in repositories using the <em>expo laptop</em>
<li>edit several pages in <a href="../computing/repos.html">repositories</a> using the <em>expo laptop</em>
<li>edit several pages using your own laptop
</ol>
@@ -28,7 +28,7 @@ using a text editor.
<ul>
<li>The expo server is on a machine far, far away that we only access remotely.
<li>These instructions apply to editing all files in the version-controlled repositories
<li>These instructions apply to editing all files in the version-controlled <a href="../computing/repos.html">repositories</a>
<li>The <em>:expoweb:</em> repository holds this handbook and templates used to display most cave data
<li>The <em>:loser:</em> repository holds the cave survey data in survex files
<li>The <em>:drawings:</em> repository holds cave survey drawings files (therion, tunnel)
@@ -49,8 +49,7 @@ easily.
website files with that on the server ("pull" from the server); (b) edit a set of .html files on your laptop so that all links between them are consistent,
(c) save the files locally, and (d) "commit" them locally;
(e) "push" the collection of changes to the expo server.
<p>See the <a href="manual.html#manual">Expo data management manual</a> for a fuller description of the version control software
repositories and how to install and use the software.
<p>See the <a href="../computing/repos.html">repositories</a> page.
<h4>What you can't do</h4>
<p>All the scans, photos, presentations, fat documents and videos are

35
handbook/computing/manual.html
View File

@@ -50,16 +50,7 @@ processes that a maintainer would want to do.</p>
<h3 id="troggle">Troggle - what it is</a></h3>
<p>Troggle runs the expo cave survey data management, presents the data on the website and manages the Expo Handbook. See the <a href="../troggle/trogintro.html">troggle intro</a>.
<h3 id="git">Version control system</a></h3>
<p>We use a distributed revision control system (<a href="https://git-scm.com/about/distributed">git</a>) for all the important data. (Note that we just use git: not GitHub, not GitLab, just <a href="https://git-scm.com/about/distributed">git</a>.)
This means that many people can edit and merge their changes with the expo
server in Cambridge at the same time: inlcuding people still on expo in the Tatty Hut
and those who have returned to the UK. Also anyone who is up
to date can take their laptop somewhere and enter data even if they have no internet access,
and the updates will be merged when they get back to civilization.
</p>
<p>In principle, survey notes can be typed into a laptop up on the plateau which would
then get synchronised when it next gets internet access.
</p>
<p>A version control system is inefficient for scanned survey notes which are large files that
do not get modified, so they are kept as a plain directory of files 'expofiles'.
@@ -69,7 +60,7 @@ The same goes for holiday photographs and GPS logs.</p>
<ol>
<li><a href="#usernamepassword">Getting a username, password and key</a></li>
<li><a href="#repositories">The repositories</a></li>
<li><a href="../computing/repos.html">The repositories</a></li>
<li><a href="#quickstart">Quick start</a></li>
<li><a href="#cavepages">Updating cave pages</a></li>
<li><a href="#updatingyears">Updating expo year pages</a></li>
@@ -96,28 +87,10 @@ Appendices:
<p>This password is all you need to log in to troggle and to use the troggle control panel (very few people need to do this). But if you want to update webpages (a much more common requirement) or to edit the software itself (very rare), then
you will also need to get a login (register a key with the server). See <a href="keyexchange.html">key-pair setup</a> for details.
<p>Pushing cave data to the :loser: and :drawings: repositories also needs a key. So cavers entering their cave survey data have to use a machine on which this already set up. These machines are
<p>Pushing cave data to the :loser: and :drawings: <a href="../computing/repos.html">repositories</a> also needs a key. So cavers entering their cave survey data have to use a machine on which this already set up. These machines are
the <i>expo laptop</i> and the laptop '<i>aziraphale</i>' which live in the potato hut during expo. If you want to use your own laptop then
see <a href="#yourownlaptop">below</a>.
<h3><a id="repositories">The repositories</a></h3>
<p>All the expo data is contained in 4 "repositories" at
expo.survex.com. This is currently hosted on a free virtual server we have blagged on a server farm.
We use a distributed version control system (DVCS) to manage these repositories because this allows simultaneous collaborative
editing and keeps track of all changes so we can roll back and have branches if needed.</p>
<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 (hg)</li>
<li><a href="/cgit/drawings/.git/log">drawings</a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/cgit/expoweb/.git/log">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="../troggle/trogintro.html">notes on troggle</a> for further explanation (git)</li>
</ul>
<h3><a id="cavepages">Updating cave pages</a></h3>
<span style="color:red">
<p>Public cave description pages are automatically generated by troggle from a set of
@@ -152,7 +125,7 @@ superseded in 2012).</p>
<p>which contains a number of files used to manage and record that year's expo. Have a look at
expoweb/years/2018/ for a recent well-documented expo (the weather was good).
Files are added and edited using the version control system for the expoweb repository.</p>
Files are added and edited using the version control system for the expoweb <a href="../computing/repos.html">repository</a>.</p>
<p>To create a new 'year' for next year's expo see <a href="newyear.html">adding a new year</a>.

2
handbook/computing/newyear.html
View File

@@ -18,7 +18,7 @@
<h3>Adding a new year in the Expo online systems</h3>
<p>There is no script to do this (yet). In the list below everything in expofiles is done by directly overwriting what is on the server. Changes to expoweb and troggle must be done using the version control system as these are repositories.
<p>There is no script to do this (yet). In the list below everything in expofiles is done by directly overwriting what is on the server. Changes to expoweb and troggle must be done using the version control system as these are <a href="../computing/repos.html">repositories</a>.
<ul>
<li>Create a new folder e.g. /2020/ in each of
<ul>

1
handbook/computing/onlinesystems.html
View File

@@ -30,6 +30,7 @@ This page is the overview. The online systems manuals are split into these secti
<li><a href="hbmanual1.html"><b>Handbook maintenance</b></a> - how to improve and update what you are reading now.
<li><a href="../troggle/trogintro.html"><b>System maintenance</b></a> - how to fix and enhance the software tools we have written:
<ul>
<li><a href="../computing/repos.html">The repositories</a></li>
<li><a href="todo.html">To-do</a> - online systems to-do list
<li><a href="../troggle/trogmanual.html">Troggle</a> - the system framework
<li><a href="../troggle/otherscripts.html">Other scripts</a>

56
handbook/computing/repos.html Normal file
View File

@@ -0,0 +1,56 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Online repositories</title>
<link rel="stylesheet" type="text/css" href="../css/main2.css" />
</head>
<body>
<style>
body {
background: #fff url(/images/style/bg-system.png) repeat-x 0 0
}
/* Use grey for system/programming/nerd pages as a visual reminder */
</style>
<h2 id="tophead">CUCC Expedition: Online repositories</h2>
<h1>Version-controlled repositories</h1>
<h3><a id="repositories">The repositories</a></h3>
<p>All the expo data is contained in 4 <var>repositories</var> or <var>repos</var> at
expo.survex.com:
<ul>
<li><a href="/repositories/loser/.git/"><var>:loser:</var></a> - the survex cave survey data (not live yet)</li>
<li><a href="/repositories/drawings/.git/"><var>:drawings:</var></a> - the tunnel and therion cave data and drawings (git)</li>
<li><a href="/repositories/expoweb/.git/"><var>:expoweb:</var></a> - the website pages, handbook, generation scripts (git)</li>
<li><a href="/repositories/troggle/.git/"><var>:troggle:</var></a> - the database/software part of the survey data management system - see <a href="../troggle/trogintro.html">notes on troggle</a> for further explanation (git)</li>
</ul>
<p>You can read or clone these without any control, but to write ("push") to them you will need to use <varssh://</var> and set up the <a href="keyexchange.html">key exchange</a>.
<p>So cavers wanting to upload their cave survey data have to use a machine on which they key is already set up. The <i>expo laptop</i> lives in the potato hut during expo and it is sometimes joined by the laptop '<i>aziraphale</i>'. These are both loaned machines running Linux. If you want to use your own laptop then
see the <a href="basiclaptop.html">minimal laptop setup</a>.
<h3 id="git">Version control system</a></h3>
<p>We use a distributed revision control system (<a href="https://git-scm.com/about/distributed">git</a>) for all the important data.
<p>Note that we just use git: not GitHub, not GitLab, just <a href="https://git-scm.com/about/distributed">git</a>.
<p>
This allows many people to edit and merge their changes at the same time. This includes people still on expo and those who have returned to the UK. Also anyone who is up
to date can take their laptop somewhere (e.g. topcamp) and enter data even if they have no Internet access,
and the updates will be merged when they get back to civilization.
</p>
<p>
We use a version control system because this keeps track of all changes so we can roll back mistakes. We also have multiple copies of the data on multiple machines for safety.
<p>
We use git because it is now the industry standard. In the past we have used <a href="https://en.wikipedia.org/wiki/Concurrent_Versions_System">cvs</a>, <a href="https://en.wikipedia.org/wiki/Apache_Subversion">subversion</a> and <a href="https://en.wikipedia.org/wiki/Mercurial">mercurial</a>.
<p>A version control system is inefficient for photos, GPS tracks and scanned survey notes which are large files that do not get modified. These are kept as a plain directory of files <a href="/expofiles"><var>/expofiles/</var></a>.
</p>
<hr />
Return to <a href="manual.html">Expo Data Maintenance manual</a><br>
Return to <a href="onlinesystems.html">Expo Systems Overview</a>
</body>
</html>

2
handbook/computing/winlaptop.html
View File

@@ -51,7 +51,7 @@
<p>Linux people like to use <em>links</em>. This is where there is really only one file, but it is referred to by different names. This is particularly useful when a file is moved, but you want people who have got the old location to still be able to find it. This happens quite a lot when updating handbooks.
<p>
The links you are most likely to come across are that what looks like
<span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/expoweb</span> is really just a link to the folder <span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/repositories/hg/expoweb</span>, <br />
<span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/expoweb</span> is really just a link to the folder <span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/repositories/git/expoweb</span>, <br />
and that
<span style="font-family:monospace; size=x-small; background-color: lightgray">expoweb/essentials.gpx</span>
is a link to the file <span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/expofiles/gpslogs/essentials/essentials2019.gpx</span>

2
handbook/computing/wookey-slides.html
View File

@@ -25,7 +25,7 @@ lang="de-at">Salzburg).</span> Recent large projects are:
<h3>Data Storage<br>
</h3>
<ul>
<li>Version-controlled repositories<br>
<li>Version-controlled <a href="../computing/repos.html">repositories</a><br>
</li>
<ul>
<li>website ('expoweb')<br>

4
handbook/computing/yourlaptop.html
View File

@@ -16,7 +16,7 @@
<ul>
<li>Install <a href="#software">software</a> to access version control and edit/view caving data.</li>
<li><a href="#configuration">Register an SSH key</a> with the expo server (i.e 'get a login').</li>
<li>Download the expo repositories so you have the files on your machine.</li>
<li>Download the expo <a href="../computing/repos.html">repositories</a> so you have the files on your machine.</li>
</ul>
<p>For a quicker, shorter guide to only the most basic setup, see the
<ul>
@@ -164,7 +164,7 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
<li><a href="../../documents/tunnel-loefflerCP35-only.pdf">Introduction to using Tunnel</a> - article by Dave Loeffler. This is really good and should be read first.
<li><a href="http://expo.survex.com/expofiles/tunnelwiki/wiki/pages/Tunnel.html">The Tunnel tutorial</a> - installation notes and a wiki of examples and tutorials
<li><a href="https://github.com/CaveSurveying/tunnelx">Tunnel - master copy since August 2019</a>. This is where the software is actively developed and is the most up to date copy, but the documentaiton is not as complete as in the other locations.
<li><a href="https://github.com/CaveSurveying/tunnelx">Tunnel - master copy since August 2019</a>. This is where the software is actively developed and is the most up to date copy, but the documentation is not as complete as in the other locations.
<li><a href="https://bitbucket.org/goatchurch/tunnelx/src/default/">bitbucket.org/goatchurch/tunnelx</a> - documentation and old source code in the bitbucket repository system.
</ul>
<img src="tunnelbanner204.jpg" > <br />