New laptop for troggle software dev documentation

This commit is contained in:
2021-10-22 21:04:23 +03:00
parent 7a614ccec8
commit cf4dc30251
5 changed files with 162 additions and 12 deletions

View File

@@ -43,12 +43,12 @@
</ul>
<h2 id="basic">Your own basic laptop</h2>
<p>If you are new to expo please use the <em>expo laptop</em> first. You don't <em>need</em> to use your own laptop - which can take several hours to configure completely.
<p>If you are new to expo and can't do what you want with just a browser and email, then please use the <em>expo laptop</em> in the potato hut first. You don't <em>need</em> to use your own laptop - which can take several hours to configure completely.
<p>To set up your own basic laptop for all cave data maintenance you need to do this:</p>
<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 two <a href="../computing/repos.html">expo repositories</a> <var>loser</var> and <var>drawings</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> [actually <var>los</var> is still (Oct.2021) using mercurial not git.</li>
<li>Clone two <a href="../computing/repos.html">expo repositories</a> <var>loser</var> and <var>drawings</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> [actually <var>loser</var> is still (Oct.2021) using mercurial not git, so this won't work.]</li>
<li>Install survex, and therion or tunnel for editing cave data.
<li>Install image editing software such as Irfanview or gimp.
<li>If you are also planning on extensive work rewriting parts of the handbook, then you will also need the <a href="../computing/repos.html">expo repository</a> <var>expoweb</var>.

View File

@@ -41,9 +41,34 @@
<li>You may already have a key on this machine. If you already have <tt>~/.ssh/id_rsa.pub</tt>, then send that.</li>
<li>If not, run <tt>ssh-keygen</tt>. It may ask about passwords: you can add a password for extra
security, but a passwordless key is fine, and more convenient.</li>
<li>That will create a file: <tt>.ssh/id_rsa.pub</tt> in your home directory. Email that file to one of the admins listed above. </li>
<li>That will create a file called (by default) <tt>.ssh/id_rsa.pub</tt> in your home directory. Email that file to one of the admins listed above. </li>
</ol>
<p>This is an example of the whole interaction where the key file has been given a different name:
<pre>
<tt>$ <b>ssh-keygen -C "philip@muscogee-wsl"</b>
Generating public/private rsa key pair.
Enter file in which to save the key (/home/philip/.ssh/id_rsa): <b>id_rsa_wsl</b>
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in <em>id_rsa_wsl</em>.
Your public key has been saved in <em>id_rsa_wsl.pub</em>.
The key fingerprint is:
SHA256:ySs0YD5IG2ZD50+riUDHWosNq+WJdqpkDlINXh709r0 philip@muscogee-wsl
The key's randomart image is:
+---[RSA 2048]----+
| . o |
| ..+ . |
| oB+* + |
|.=O%.* + o |
|.+*o= = S . |
|.* o = . . . |
|=++.o . . E |
|B o . |
|oo |
+----[SHA256]-----+
$
</tt>
</pre>
<h3>MacOS</h3>

View File

@@ -16,8 +16,19 @@
<p>If you can get to the <em>expo laptop</em> try these commands on that first as the key exchange has already been done. If the key exchnage has not been done then none of this will work.</p>
<p>You can read or clone these repos without any control, but to write ("push") to them you will need to use <var>ssh://expo@expo.survex.com</var> and set up the <a href="keyexchange.html">key exchange</a>.</p>
<p>NOTE: always use user <var>'expo'</var> as the login user (<var>ssh://expo@...</var>) even though within git you will be identified by your own ssh key name.</p>
<p>Open a terminal in a new directory, e.g. /tmp/experiments/ in which you want to create the repo. It will automatically create a folder with the repo name e.g.'troggle' in that directory.</p>
<dl><dt>expoweb (The data management system)</dt><dd><tt>git clone ssh://expo@expo.survex.com/home/expo/expoweb</tt> (read/write)</dd><dt>troggle (The data management system backend)</dt><dd><tt>git clone ssh://expo@expo.survex.com/home/expo/troggle</tt> (read/write)</dd><dt>loser (The survey data) - this will fail until it is moved from hg to git</dt><dd><tt>git clone ssh://expo@expo.survex.com:loser</tt> (read/write)</dd><dt>drawings</dt><dd><tt>git clone ssh://expo@expo.survex.com/home/expo/drawings</tt> (read/write)</dd></dl>
<dl>
<dt>loser (The survey data) - <em>this will fail until it is moved from hg to git</em></dt><dd>This is all the survex files. You need this if you are rearranging and editing a lot of survey files.<tt>git clone ssh://expo@expo.survex.com:loser</tt> (read/write)</dd>
<dt>drawings</dt><dd>These are the therion and tunnel cave vector drawing files. You need this if you are 'tunneling' a lot of cave surveys.<tt>git clone ssh://expo@expo.survex.com/home/expo/drawings</tt> (read/write)</dd>
<dt>expoweb</dt><dd>These are all webpages, mostly the expo handbook. You need this only if you are editing a lot of handbook pages.<tt>git clone ssh://expo@expo.survex.com/home/expo/expoweb</tt> (read/write)</dd>
<dt>troggle</dt><dd>This is the python code that runs troggle and generates 2,000 webpages of reports and tables. This is what you need for software development.<tt>git clone ssh://expo@expo.survex.com/home/expo/troggle</tt> (read/write)</dd>
</dl>
<h3>Using git</h3>
<p><a href="https://stevebennett.me/2012/02/24/10-things-i-hate-about-git/"><img class="onright" src="git-arrows31.png" alt="git bread &amp; butter commands subset" width="250" /></a>You may find these useful:</p>
<ul>