mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-11-25 08:41:54 +00:00
missed one
This commit is contained in:
parent
beeca2cc25
commit
6a05848060
222
handbook/computing/manual.html
Normal file
222
handbook/computing/manual.html
Normal file
@ -0,0 +1,222 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>CUCC Expedition Handbook: Programmers manual</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/main2.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h2 id="tophead">CUCC Expedition Handbook - Online systems</h2>
|
||||
<h1>Expo Data Maintenance Manual</h1>
|
||||
|
||||
<h2><a id="manual">Expo data management programmers' manual</a></h2>
|
||||
|
||||
<ul>
|
||||
<li>This page is for cavers wanting to edit any expo data on their own machine. So that's the website, survey data, or drawn up surveys</li>
|
||||
<li>This page is <i>not</i> for cavers wanting to know how to type in logbooks or upload photographs or edit data on the expo laptop.
|
||||
|
||||
<li>There is another page with more info on <a href="#yourownlaptop">the software expo uses and setting up your own laptop</a>.
|
||||
</ul>
|
||||
|
||||
<p>Editing the expo data management system is an adventure. 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 data management system, refer to
|
||||
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>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>
|
||||
|
||||
<ol>
|
||||
<li><a href="#usernamepassword">Getting a username, password and key</a></li>
|
||||
<li><a href="#repositories">The repositories</a></li>
|
||||
<li><a href="#howitworks">How the data management system works</a></li>
|
||||
<li><a href="#yourownlaptop">Your own laptop</a></li>
|
||||
<li><a href="#quickstart">Quick start</a></li>
|
||||
<li><a href="#editingthedata management system">Modifying the data management system</a></li>
|
||||
<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="#surveystatus">Maintaining the survey status table</a></li>
|
||||
<li><a href="#menu">Cave pages and handbook menu system</a></li>
|
||||
|
||||
</ol>
|
||||
Appendices:
|
||||
<ul>
|
||||
<li><a href="../website-history.html">Website history</a> - a history of the data management system up to 2019</li>
|
||||
<li><a href="../c21bs.html">Taking Expo Bullshit into the 21st Century</a> - initial report from 1996</li>
|
||||
</ul>
|
||||
|
||||
<h3><a id="usernamepassword">Getting a username, password and key</a></h3>
|
||||
|
||||
<p>You don't need a password to view most things, but you will need one to change them.</p>
|
||||
|
||||
<p>Use these credentials for access to the troggle site. The user is 'expo',
|
||||
with a cavey:beery password. Ask someone if this isn't enough clue for you.
|
||||
<b>This password is important for security</b>. The whole site <strong>will</strong> get hacked by spammers or worse if you are not careful with it. Use a secure method for passing it on to others that need to know (i.e not unencrypted email), don't publish it anywhere, don't check it in to the data management system by accident. A lot of people use it and changing it is a pain for everyone so do take a bit of care.
|
||||
</p>
|
||||
|
||||
<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
|
||||
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="/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="../troggle/trogintro.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.
|
||||
|
||||
<h4>Mercurial Website Hack 2019</h4>
|
||||
<p> Currently (December 2019) after commiting and pushing your changes to expoweb to the mercurial server, you will need to
|
||||
login to expo.survex.com using ssh, cd to /expoweb/ and issue a "<a href="https://www.selenic.com/mercurial/hg.1.html">hg update</a>" command to make your changes noticed by the webserver. This problem will go away before Expo 2020 - we hope - when we finish migrating from mercurial to git.
|
||||
|
||||
<p>All the scans, photos, presentations, fat documents and videos are
|
||||
stored just as files (not in version control) in 'expofiles'. See
|
||||
below for details on that.</p>
|
||||
|
||||
<h3><a id="howitworks">How the data management system works</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>.
|
||||
|
||||
<p>Anything you check in which affects cave data or descriptions won't appear on the site until
|
||||
the data management system update scripts are run.
|
||||
This <em>should</em> happen automatically every 30 mins (not since 2017), but you can also kick off a manual update.
|
||||
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 (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
|
||||
complicated process. At a minimum you will be an experienced software nerd already and will have git, mercurial and a text editor installed and you will know how to use them.
|
||||
You will have done the
|
||||
<a href="keyexchange.html">key-pair setup</a> process - which you can only do entirely on your own if
|
||||
you have access to the <i>expo laptop</i>.
|
||||
<p>See <a href="basiclaptop.html">setting up a minimal laptop</a> for a short list of software. This assumes you know how to use it all.
|
||||
<br />See <a href="yourlaptop.html">setting up your own laptop</a> for the full list of software we use and where to get it.
|
||||
<p>Note that the instructions are primarily for people using Linux with some help for those using Windows. If you are a Mac user then you are on your own.
|
||||
|
||||
|
||||
<h3><a id="editthispage">Using 'Edit This Page'</a></h3>
|
||||
<p>This can be used to edit web pages without installing any software or doing any key-pair setup. It even works if your laptop is a Mac.
|
||||
<p>This is the capability that you can see in the top-left-hand menu on any website page if you <a href="/accounts/login/">log in to troggle</a> using the <a href="#usernamepassword">cavey:beery password</a>.
|
||||
<p>'Edit This Page' is a troggle capability edits the file served by the webserver but it does not update the copy of the file in the
|
||||
repository (the invese of the problem described above as 'Mercurial Website Hack'). To properly finish the job you need to
|
||||
<ul>
|
||||
<li>
|
||||
ssh into expo@expo.survex.com (use putty on a Windows machine)
|
||||
<li>cd to the directory containing the repo you want, i.e. "cd loser" for
|
||||
cave data or "cd expoweb" for the handbook and visible data management system, which takes you to /home/expo/expoweb
|
||||
<li>Then run "<a href="https://www.selenic.com/mercurial/hg.1.html">hg status</a>" (to check what
|
||||
changes are pending),
|
||||
<li>then "hg diff" to see the changes in detail
|
||||
(or "hg diff|less" if you know how to use "less" or "more") and
|
||||
<li>then DO NOT just run '<a href="https://www.selenic.com/mercurial/hg.1.html">hg commit</a>' unless you know how emacs works as it will dump
|
||||
you into an emacs editing window (C-x C-C is the way to exit emacs). Instead, do
|
||||
'hg commit -m "found files left over - myName" '
|
||||
which submits the obligatory comment witht he commit operation.
|
||||
</ul>
|
||||
<p>Again, we hope that this issue will go away when we migrate the expoweb repo from mercurial to git before the 2020 Expo.
|
||||
|
||||
|
||||
<h3><a id="../manual/#editingthedata management system">Editing the data management system</a></h3>
|
||||
|
||||
<p>To edit the data management system fully, you need to use the version control system
|
||||
software which is currently git and mercurial.
|
||||
Some (static text) pages can be edited directly on-line using the 'edit this page link' which you'll
|
||||
see if you are logged into troggle. In general the dynamically-generated pages, such as those describing
|
||||
caves which are generated from the cave survey data, can not be edited in this way, but forms are provided
|
||||
for some types of these like 'caves'.</p>
|
||||
|
||||
<h3>Cheat lists and quick reminders</h3>
|
||||
<p>If you know what you are doing here is the basic info on what's where:<br />
|
||||
(if you don't know what you're doing, skip to <a href="#editingthedata management system">Editing the data management system</a> below.)
|
||||
<ul>
|
||||
<li>Quick <a href="qstart-git.html">reminders for using git</a> at the command line.
|
||||
<li>Quick <a href="qstart-hg.html">reminders for using mercurial</a> at the command line. (to be removed)
|
||||
<li>Quick <a href="manual.html#quickstart">reminders for using rsync</a> at the command line.
|
||||
</ul>
|
||||
|
||||
<p>Simple changes to static HTML files will take effect immediately (or as soon as the hg update hack is done, but this will disappear when we move entirely to git),
|
||||
but changes to dynamically-generated files - cave descriptions, QM lists etc. -
|
||||
will not take effect, until a nerd runs the expoweb-update script on the server.</p>
|
||||
|
||||
<h3><a id="expowebupdate">The expoweb & drawings import scripts</a></h3>
|
||||
|
||||
<p>The import scripts for the cave data are currently (Feb.2020) run manually by a nerd. So if you enter cave data,logbooks or survey scans you won't see the result
|
||||
until a nerd has been placated.</p>
|
||||
|
||||
|
||||
<h3><a id="cavepages">Updating cave pages</a></h3>
|
||||
|
||||
<p>Cave description pages are automatically generated from a set of
|
||||
cave files in noinfo/cave_data/ and noinfo/entrance_data/. These files
|
||||
are named <area>-<cavenumber>.html (where area is 1623 or 1626). These
|
||||
files are processed by troggle. Use <tt>python databaseReset.py
|
||||
caves</tt> in /expofiles/troggle/ to update the site/database after
|
||||
editing these files.
|
||||
Use <tt>python databaseReset.py
|
||||
</tt> on its own to get a list of command options and brief explanations.</p>
|
||||
|
||||
<p>Clicking on 'New cave' (at the bottom of the cave index) lets you enter a new cave. <a href="caveentry.html">Info on how to enter new caves has been split into its own page</a>.</p>
|
||||
|
||||
<p>(If you remember something about CAVETAB2.CSV for editing caves, that was
|
||||
superseded in 2012).</p>
|
||||
<p>This may be a useful reminder of what is in a survex file <a href="../survey/how_to_make_a_survex_file.pdf">how to create a survex file</a>.
|
||||
|
||||
|
||||
<h3><a id="updatingyears">Updating expo year pages</a></h3>
|
||||
|
||||
<p>Each year's expo is recorded in the folder</p>
|
||||
|
||||
<tt>/expoweb/years/</tt>
|
||||
|
||||
<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>
|
||||
|
||||
<p>To create a new 'year' for next year's expo see <a href="newyear.html">adding a new year</a>.
|
||||
|
||||
|
||||
|
||||
<h3><a id="surveystatus">Maintaining the survey status table</a></h3>
|
||||
<p>See the <a href="../survey/onlinewallet.html">documentation</a> on updating the online surveyscans folders using the lever-arch file of plastic wallets.
|
||||
|
||||
<h3><a id="menu">Cave pages and handbook menu design</a></h3>
|
||||
<p>See the <a href="menudesign.html">menu design history and proposals</a>
|
||||
page on where we are and what we might do to improveand fix menus.
|
||||
|
||||
|
||||
<hr />
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user