expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-22 07:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

de-mercurialising handbook

Browse Source
This commit is contained in:
Philip Sargent 2020-04-24 22:33:51 +01:00
parent 8f87fb90d9
commit 904c541b8b
5 changed files with 7 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
handbook/computing/basiclaptop.html
View File

@ -43,7 +43,7 @@ And please <b>write some documentation for the next person</b> in your situation
<h2 id="configuration">Configuration</h2>
<p>Follow this link to <a href="keyexchange.html">register a key with the expo server</a> to get upload (i.e. read/write) access.
Do this first, Without it none of git, mercurial, scp, ftp or rsync will work.
Do this first, Without it none of git, scp, ftp or rsync will work.
<p>On a Windows machine you will need to configure pageant (the putty authentication agent)
to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-keys.html">run at startup to load your key</a>.

9
handbook/computing/hbmanual2.html
View File

@ -58,7 +58,7 @@ not stored in the version control repositories so you cannot edit or change them
<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.
complicated process. At a minimum you will be an experienced software nerd already and will have git 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>.
@ -71,7 +71,6 @@ you have access to the <i>expo laptop</i>.
<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>
@ -80,13 +79,7 @@ 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>

7
handbook/computing/manual.html
View File

@ -51,7 +51,7 @@ processes that a maintainer would want to do.</p>
<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>, and formerly mercurial) 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>.)
<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
@ -65,8 +65,6 @@ then get synchronised when it next gets internet access.
do not get modified, so they are kept as a plain directory of files 'expofiles'.
The same goes for holiday photographs and GPS logs.</p>
<p>In 2019 we had half our <a href="manual.html#repositories">version-controlled repositories</a> under mercurial and half under git.
The intention is to move entirely to git before the 2020 expo.
<h3>Contents </h3>
<ol>
@ -115,10 +113,9 @@ editing and keeps track of all changes so we can roll back and have branches if
<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/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>
<p>We have migrated two of these to git but the other two still use mercurial.
<h3><a id="cavepages">Updating cave pages</a></h3>

3
handbook/computing/todo.html
View File

@ -67,9 +67,6 @@ If a heading is in italics, then there are hidden items.
<dd><!--2020-04-11 psargent-->Diagrams of major sections: survey handbook, rigging handbook, computing handbook, Areas, cave data..</dd>
<dd><!--2020-04-11 psargent-->Chase Airoa to help fix <a href="../troggle/menudesign.html">the menus for phones</a></dd>
<dd><!--2020-04-11 psargent-->Look at <a href="https://www.gov.uk/guidance/government-design-principles">gov.uk guidelines</a> for inspiration</dd>
<dt><!--2020-04-11 psargent-->When git migration done
<dd>Edit out all mercurial
<dt><!-- 2020-04-11 psargent -->NOEDIT flag
<dd><!-- 2020-04-11 psargent -->When editing multiple pages (using git), describe how this is implemented using &lt;meta name="keywords" content="NOEDIT"&gt;
<dt>Editing Logbooks

6
handbook/computing/yourlaptop.html
View File

@ -51,7 +51,6 @@ but all the recommended software here is open source (and please don't install p
<p>The list of software:
<ul>
<li><a href="https://git-scm.com/">git</a> - distributed version control system - already installed on Linux probably</li>
<li><a href="https://www.mercurial-scm.org/">mercurial</a> - distributed version control system (to be deprecated during 2020)</li>
<li><a href="../fzconfig.html">Filezilla</a> - ftp GUI software with a configuration file to get to the expo server</li>
<li><a href="https://survex.com/download.html">Survex</a>, including the Aven visualisation tool.
<li><a href="https://github.com/CaveSurveying/tunnelx">Tunnel</a>: 2.5D cave drawing program based on Survex-compatible data which can also read PocketTopo files. (Generally called 'tunnel' even though the project and executable is actually 'tunnelx'.)
@ -89,7 +88,7 @@ but all the recommended software here is open source (and please don't install p
<p></p>None of this works until you set up the key-pair setup using PuTty/Pageant.
<ul>
<li><a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html">PuTTY</a> including pagent. Version 0.73 was released on 2019-09-29. You need this to generate and to use ssh keys on Windows. Otherwise none of git, mercurial, scp, ftp or rsync will work. It includes command line tools ssh, scp (pscp) and sFTP (psftp).
<li><a href="https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html">PuTTY</a> including pagent. Version 0.73 was released on 2019-09-29. You need this to generate and to use ssh keys on Windows. Otherwise none of git, scp, ftp or rsync will work. It includes command line tools ssh, scp (pscp) and sFTP (psftp).
<li><a href="https://desktop.github.com/">GitHub Desktop for Windows</a> - yes this works with the expo server
<li><a href="">VS Code</a> is a free (but not FOSS) editor with in-built git capability and plug-ins which render git branches graphically. Also available for Linux.
<li><a href="https://gitforwindows.org/">Git for Windows</a> - not as simple to use as it looks
@ -119,7 +118,7 @@ but all the recommended software here is open source (and please don't install p
<h2><a name="configuration">Configuration</a></h2>
<p>You need to <a href="keyexchange.html">register a key with the expo server</a> to get upload (i.e. read/write) access. Do this first, Without it none of git, mercurial, scp, ftp or rsync will work.
<p>You need to <a href="keyexchange.html">register a key with the expo server</a> to get upload (i.e. read/write) access. Do this first, Without it none of git, scp, ftp or rsync will work.
You can do this entirely on your own if you have access to the <i>expo laptop</i> to upload and install the public key generated by your laptop.</p>
<p>On a Windows machine you will need to configure pageant (the putty authentication agent)
@ -167,7 +166,6 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
<h3>Cheat lists and quick reminders</h3>
<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 during 2020)
<li>Quick <a href="qstart-rsync.html">reminders for using rsync</a> at the command line.
</ul>