added git updating process - online edit of handbook/computing/winlaptop.html

This commit is contained in:
2025-06-23 08:14:21 +01:00
committed by Expo on server
parent aab3f1e289
commit b4e5a29e03

View File

@@ -136,10 +136,45 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
- PDF - Brendan's guide. Uses puTTY and GitKraken on WIndows. Read this, but most people will need to use VS Code instead of Git Kraken.
<p>Some software, such as the commercial (but free) GitKraken, requires that you click a checkbox to say that you are "using local SSH agent" rather than specifying ssh private keys explicitly (File->Preferences->Authentication in GitKraken).
<h3 id="process">The complete process sequence</h3>
<p>Whatever software you use, this is the procedure you need to follow.
<ol>
<li>Get the files you are going to edit onto your personal device (using scp, filezilla or git)
<li>Edit the files on your device
<li>either
<ul>
<li>git add the files to your local git repo
<li>git commit -m "this is my edit, I changed..."
<li>git push<br>
which will upload your edited file and also register it in ther version control system on the server
</ul>
<li>or
<ul>
<li>upload the edited file with scp or filezilla
<li>login to the server using ssh (or putty on Windows)
<li><em>on the server:</em>:
<ul>
<li>cd expoweb (if editing handbook), or cd loser (if editing survex files), or cd drawings (if editing drawings) - wherever you uploaded the files to
<li>git add the files to the server git repo
<li>git commit -m "this is my edit, I changed..., my name is [Inigo Montoya]"
<br>
which will register your edited file in thee version control system on the server. <br>This is VITAL otherwise all the online forms that attempt to uplaod files for ordinary (non-bulk update) users will fail because the got repo you have uploaded to is not in he expected state.
</ul>
</ul></ol>
<p>Note that the <var>:drawings:</var> repo also contains all the wallets configurations for all years, so if you screw up the drawings repo state, none of the online wallets updating stuff will work.
<h3 id="problems">Things that cause problems</h3>
<h4>git state incompletely tidied up</h4>
<p>
See <a href="#process">complete process sequence </a> above.
<h4>Filenames</h4>
<p>Linux allows characters in filenames which Windows doesn't. There are also apparently normal filenames which Windows rejects (such as "<a href="https://answers.microsoft.com/en-us/windows/forum/windows_7-files/why-cant-i-create-a-folder-with-name/23c86662-4988-4c7d-9c2d-3e33d4413de3">CON</a>") for historical reasons. Linux filenames are case-senstitive and Windows filenames aren't: beware.
<h4>Symbolic links and file-transfer</h4>
<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.