From 7bdc1f543549fe3a95c2ba82fa727fcb422134ed Mon Sep 17 00:00:00 2001 From: "Philip Sargent (muscogee)" Date: Sun, 1 Mar 2020 15:47:10 +0000 Subject: [PATCH] Brendan's PDF guides (original PPTX files - some - on expofiles/training-info) --- handbook/computing/logbooks-parsing.html | 3 ++ handbook/computing/qstart-rsync.html | 59 ++++++++++++++++++++++++ handbook/computing/yourlaptop.html | 31 +++++++++---- handbook/manual.html | 54 +++------------------- handbook/survey/newcave.html | 3 ++ handbook/survey/newsurvex.html | 9 +++- handbook/survey/newwallet.html | 4 ++ 7 files changed, 104 insertions(+), 59 deletions(-) create mode 100644 handbook/computing/qstart-rsync.html diff --git a/handbook/computing/logbooks-parsing.html b/handbook/computing/logbooks-parsing.html index d91b23c10..c86fa62d5 100644 --- a/handbook/computing/logbooks-parsing.html +++ b/handbook/computing/logbooks-parsing.html @@ -9,6 +9,9 @@

CUCC Expedition Handbook

Logbooks Import

+

Importing the logbook into troggle

diff --git a/handbook/computing/qstart-rsync.html b/handbook/computing/qstart-rsync.html new file mode 100644 index 000000000..978aab2c6 --- /dev/null +++ b/handbook/computing/qstart-rsync.html @@ -0,0 +1,59 @@ + + + + +Handbook - Quick rsync + + + +

CUCC Expedition Handbook - rsync Quick

+ +

Quick Reminder - rsync

+

Manual Version Control using rsync

+

This is NOT a tutorial. This is a set of reminders for people who already know all this stuff. + + +

+
expofiles (all the big files and documents)
+ +

Photos, scans (logbooks, drawn-up cave segments) (This was about +40GB of stuff in 2019 which you probably don't actually need locally). +

If you don't need an entire copy of all of it, then it is probably best to use Filezilla/ftp to +copy just a small part of the filesystem to your own machine and to upload the bits you add to or edit. +Instructions for installing and using Filezilla are found in the expo user instructions for +uploading photographs: uploading.html. + +

To sync all +the files from the server to your local expofiles directory on your laptop:

+ +

rsync -nazv --delete-after --prune-empty-dirs expo@expo.survex.com:expofiles/ /home/expo/expofiles

+ +

To sync the local expofiles directory back to the server after you have edited updates (e.g. scanned some hand-drawn surveys into expofiles/surveyscans/ (but only if your machine runs Linux):

+ +

rsync -nazv /home/expo/expofiles/surveyscans/2019/ expo@expo.survex.com/expofiles/surveyscans/2019

+ +then CHECK that the list of files it produces matches the ones you absolutely intend to delete forever! ONLY THEN do it without the "-n" option. "-n" is the same as "--dry-run" which shows you the overwriting changes but doesn't actually do them. + +

Always +

+ +

(do be incredibly careful not to delete piles of stuff then rsync back, or to get the directory level of the command wrong - as it'll all get deleted on the server too, and we may not have backups!). It's absolutely vital to use rsync --dry-run --delete-after first to check what would be deleted. + +

If you are using rsync from a Windows machine you will not get all the files as some filenames are incompatible with Windows. What will happen is that rsync will invisibly change the names as it downloads them from the Linux expo server to your Windows machine, but then it forgets what it has done and tries to re-upload all the renamed files to the server even if you have touched none of them. Now there won't be any problems with simple filenames using all lowercase letters and no funny characters, but we have nothing in place to stop anyone creating such a filename somewhere in that 40GB or of detecting the problem at the time. So don't do it. If you have a Windows machine use Filezilla not rsync. + +

(We may also have an issue with rsync not using the appropriate user:group attributes for files pushed back to the server. This may not cause any problems, but watch out for it.)

+
+ + + +
+ + + + diff --git a/handbook/computing/yourlaptop.html b/handbook/computing/yourlaptop.html index 1de280f12..f710f117a 100644 --- a/handbook/computing/yourlaptop.html +++ b/handbook/computing/yourlaptop.html @@ -18,8 +18,12 @@
  • Register an SSH key with the expo server (i.e 'get a login').
  • Download the expo repositories so you have the files on your machine.
    • -

    This is a complete list for doing software development of survex and tunnel (but not troggle) as well as accessing expo data and doing survey data reduction. -The software development stuff should be separated out into separate pages.

    +

    This is a complete list for doing software development of survex and tunnel + (but not troggle) as well as accessing expo data and doing survey data reduction. +This page needs to be edited so that the software development stuff is separated +out into separate pages.

    +So that the people who only want to do cave data stuff +don't see a lot of complex stuff they don't need.

    Operating Systems

    For Windows users only: +

    None of this works until you set up the key-pair setup using PuTty/Pageant. + +
  • Read our instructions for setting up TortoiseHg in + Tortoise-on-Windows. To be replaced by git in Sprin 2020. +

    For Android phones:


    +

    Cheat lists and quick reminders

    Logins to external systems

    diff --git a/handbook/manual.html b/handbook/manual.html index 8d9ae6c95..ca451f3a4 100644 --- a/handbook/manual.html +++ b/handbook/manual.html @@ -156,64 +156,22 @@ which submits the obligatory comment witht he commit operation.

    Again, we hope that this issue will go away when we migrate the expoweb repo from mercurial to git before the 2020 Expo. -

    Quick start

    -

    If you know what you are doing here is the basic info on what's where:
    -(if you don't know what you're doing, skip to Editing the data management system below.) +

    Editing the data management system

    -

    This section is all about how to use mercurial. Since we are changing to git it has been -removed to a separate place. - - -

    -
    expofiles (all the big files and documents)
    - -

    Photos, scans (logbooks, drawn-up cave segments) (This was about -40GB of stuff in 2019 which you probably don't actually need locally). -

    If you don't need an entire copy of all of it, then it is probably best to use Filezilla/ftp to -copy just a small part of the filesystem to your own machine and to upload the bits you add to or edit. -Instructions for installing and using Filezilla are found in the expo user instructions for -uploading photographs: uploading.html. - -

    To sync all -the files from the server to your local expofiles directory on your laptop:

    - -

    rsync -nazv --delete-after --prune-empty-dirs expo@expo.survex.com:expofiles/ /home/expo/expofiles

    - -

    To sync the local expofiles directory back to the server after you have edited updates (e.g. scanned some hand-drawn surveys into expofiles/surveyscans/ (but only if your machine runs Linux):

    - -

    rsync -nazv /home/expo/expofiles/surveyscans/2019/ expo@expo.survex.com/expofiles/surveyscans/2019

    - -then CHECK that the list of files it produces matches the ones you absolutely intend to delete forever! ONLY THEN do it without the "-n" option. "-n" is the same as "--dry-run" which shows you the overwriting changes but doesn't actually do them. - -

    Always -

      - -
    • do a dry-run of rsync from the server to your laptop immediately before you do an upload to the server -
    • use --delete-after --prune-empty-dirs when downloading, but never when uploading -
    • work at the minimum scope of folders you need, e.g. within expofiles/photos/ or expofiles/surveyscans/ not for the whole of expofiles all at once. -
    • take exagerated care with the placement of the final slash in directory parameters to the rsync. Get it wrong and you duplicate things instead of updating them and it takes ages to sort out. -
    - -

    (do be incredibly careful not to delete piles of stuff then rsync back, or to get the directory level of the command wrong - as it'll all get deleted on the server too, and we may not have backups!). It's absolutely vital to use rsync --dry-run --delete-after first to check what would be deleted. - -

    If you are using rsync from a Windows machine you will not get all the files as some filenames are incompatible with Windows. What will happen is that rsync will invisibly change the names as it downloads them from the Linux expo server to your Windows machine, but then it forgets what it has done and tries to re-upload all the renamed files to the server even if you have touched none of them. Now there won't be any problems with simple filenames using all lowercase letters and no funny characters, but we have nothing in place to stop anyone creating such a filename somewhere in that 40GB or of detecting the problem at the time. So don't do it. If you have a Windows machine use Filezilla not rsync. - -

    (We may also have an issue with rsync not using the appropriate user:group attributes for files pushed back to the server. This may not cause any problems, but watch out for it.)

    -
    -

    Editing the data management system

    - -

    To edit the data management system fully, you need to use the disributed version control system -(DVCM) software which is currently mercurial/TortoiseHg. +

    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'.

    Cheat lists and quick reminders

    +

    If you know what you are doing here is the basic info on what's where:
    +(if you don't know what you're doing, skip to Editing the data management system below.)

    diff --git a/handbook/survey/newcave.html b/handbook/survey/newcave.html index e9fbb023e..a3f6e28d9 100644 --- a/handbook/survey/newcave.html +++ b/handbook/survey/newcave.html @@ -9,6 +9,9 @@

    CUCC Expedition Handbook - New Cave

    Creating a new cave in the online system

    +

    Great, I have discovered a new cave...

    So, you have staggered off the plateau with a fist-full of notes and surveys, diff --git a/handbook/survey/newsurvex.html b/handbook/survey/newsurvex.html index 2925d2288..6eaf18b12 100644 --- a/handbook/survey/newsurvex.html +++ b/handbook/survey/newsurvex.html @@ -14,6 +14,9 @@

    If you have not come to this page from the sequence starting at Starting a New Cave" then go and read that first.

  • This page outlines the next step of the process. Each part of it is documented separately. +

    Process

    @@ -34,7 +37,7 @@ and tell someone nerdy when you have finished and they will ensure that it is saved, committed, and pushed appropriately.

    If you have several parts of the cave surveyed on one trip, create several distinct .svx files.

    + +

    Process