mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-11-27 09:42:02 +00:00
98 lines
5.3 KiB
HTML
98 lines
5.3 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<title>CUCC Expedition Handbook: editing the handbook</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../css/main2.css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<h2 id="tophead">CUCC Expedition Manuals - Editing the Handbook</h2>
|
||
|
|
<h1>Editing the Handbook (2)</h1>
|
||
|
|
|
||
|
|
<h2>Handbook and Repository editing</h2>
|
||
|
|
|
||
|
|
<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 using your own laptop
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 id="edithandbook">2. Editing this handbook and files in repositories</h3>
|
||
|
|
<p>The primary and recommended way of editing this handbook, historic expo files and survey data is to use
|
||
|
|
a laptop which has the version control software installed and configured. The
|
||
|
|
person editing needs to know how to use this software, and also needs to know how to edit raw HTML files
|
||
|
|
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>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)
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The <em>Expo laptop</em> has the necessary software installed, so it is best to learn how to do this
|
||
|
|
when sitting at that laptop.
|
||
|
|
|
||
|
|
<p>It's important to understand that the pages you can edit by this method
|
||
|
|
are stored in a version control system (see 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>The recommended editing workflow is to (a) use the version control software to synchronise your local laptop copy of the
|
||
|
|
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.
|
||
|
|
|
||
|
|
<h4>What you can't do</h4>
|
||
|
|
<p>All the scans, photos, presentations, fat documents and videos are
|
||
|
|
not stored in the version control repositories so you cannot edit or change them using the method described here.</p>
|
||
|
|
|
||
|
|
<h3><a id="yourownlaptop">3. Your own laptop</a></h3>
|
||
|
|
<p>Setting up 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 ssh
|
||
|
|
<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>Cheat lists and quick reminders</h3>
|
||
|
|
<p>If you know what you are doing here is the basic info on what's where:<br />
|
||
|
|
|
||
|
|
<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, see below),
|
||
|
|
but changes to dynamically-generated files - cave descriptions, QM lists etc. -
|
||
|
|
will not take effect, until the troggle <a href="../troggle/trogintro.html">import/update scripts</a> are run on the server. These should <a href="../troggle/otherscripts.html">run automatically and frequently</a> but currently they are run manually by nerds as the expo server is undergoing heavy software maintenance. </p>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
<h4>Mercurial Website Hack 2019</h4>
|
||
|
|
|
||
|
|
<p> Currently [April 2020] after commiting and pushing your changes to the <em>:expoweb:</em> or <em>:loser:</em> respositories, you will need to
|
||
|
|
login to expo.survex.com using ssh, cd to ~/expoweb/ (or ~/loser/) 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 during 2020 when Wookey finishes migrating these repos from mercurial to git.
|
||
|
|
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
<p>Back to to "<a href="hbmanual1.html">Edit this page</a>"<br />
|
||
|
|
Forwards to <a href="manual.html">Data Management Manual</a>
|
||
|
|
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|