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

to-do lists updated (still very incomplete)

Browse Source
This commit is contained in:
Philip Sargent 2020-07-26 00:37:53 +01:00
parent d95558c84f
commit d58924d32d
3 changed files with 37 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
handbook/computing/onlinesystems.html
View File

@ -47,6 +47,7 @@ This page is the overview. The online systems manuals are split into these secti
<li><a href="../gpxupload.html">Uploading GPS tracks</a></li>
<li><a href="../survey/newcave.html">Recording a new cave discovery</a></li>
<li><a href="../survey/status.html">Monitoring the cave survey workflow status</a></li>
<li><a style="color: blue" href="contribute.html">How can I contribute?</a>
</ul>
<p><strong>Surveying and recording survey data is the reason all this exists.</strong> The "survey handbook" part of this handbook gives instructions to beginners for how to record discoveries and surveys. <p><a href="../survey/why.htm"><img class="onleft" src="go-caving-th.jpg"></a>The "data maintenance" manual is where to look for help when things go wrong: the data has been entered incorrectly, or software has crashed due to corrupt input data.
<p>The "system maintenance" manual may of interest to a caver who wonders how it is all put together but should not be needed by most people.

10
handbook/computing/todo-data.html
View File

@ -72,8 +72,6 @@ If a heading is in italics, then there are hidden items.
<dd> edit logbook entries 2018, 2019 to link to extensive photos of Garlic cave area {Withnall 2018} , {Becka 2019}
<dt>2018 Logbook</dt>
<dd>Check Natalie Uomini's typed entries and extensive photos are minimized and linked in properly to the HTML logbook
<dt>Add missing images to logbooks</dt>
@ -83,6 +81,8 @@ If a heading is in italics, then there are hidden items.
<dd><!--2020-05-10 psargent--> RENAME files of photos /2018/BlogPostPhotos/* from .JPG to .jpg as the generated .xml files get confused.
<dt>2011 logbook:</dt>
<dd>type up via-ferrate & bolt-testing writeups (In paper book, not in scan or HTML)</dd>
<dt><!--2020-07-24 psargent-->1982 Logbook - no diagrams</dt>
<dd>It has been typed but there are no diagrams. Scanned PDF recently acquired.
<dt>200? logbook:</dt>
<dd>Type up "list of GPS locations still to type"</dd>
@ -111,7 +111,7 @@ If a heading is in italics, then there are hidden items.
<dd>2017, 2018, 2019 wallet binders are in Philip S.'s house.
</dl>
<h3><!--2020-04-17 psargent-->:expoweb:/1623/264/cavedescription2016<br><br> (All moved verbatim, now deleted)</h3>
<h3><!--2020-04-17 psargent-->:expoweb:/1623/264/cavedescription2016<br><br> (All moved verbatim, original to-do file now empty.)</h3>
<dl>
<dt>
tightyorkshireman
@ -217,7 +217,7 @@ From here archway leads onto bouldery ledge in side of very large chamber
to be explored.
</dl>
<h3><!--2020-04-19 psargent-->/expofiles/surveyscans/2017/2017notes.txt<br><br> (All moved verbatim, now deleted)</h3>
<h3><!--2020-04-19 psargent-->/expofiles/surveyscans/2017/2017notes.txt<br><br> (All moved verbatim, original to-do file now empty.)</h3>
<dl>
<dt>258
<dd>
@ -351,7 +351,7 @@ badforecast 2017#51
</pre>
</dl>
<h3><!--2020-04-17 psargent-->:expoweb:/1623/264/trident_to_little_boy.txt<br><br> (All moved verbatim, now deleted)</h3>
<h3><!--2020-04-17 psargent-->:expoweb:/1623/264/trident_to_little_boy.txt<br><br> (All moved verbatim, original to-do file now empty.)</h3>
<dl>
<dt>
Cave: Balcony (Far Side to Deep Balcony)

45
handbook/computing/todo.html
View File

@ -79,8 +79,9 @@ If a heading is in italics, then there are hidden items.
<dt>Areas (these are the sub-areas)
<dd><!--2020-05-01 psargent-->Downgrade the "areas" aspect of the documentation as we don't use these now
<dd><!--2020-05-01 psargent-->Add links to these resurrected area guides from relevant other parts of the handbook</dd>
<dt>Prospecting Guides & slippy map & GPS tracks
<dt>Prospecting Guides & slippy map & GPS tracks
<dd><!--2020-07-24 psargent-->Redesign to be used as overlay on phone/tablet using essentials.gpx data
<dd><!--2020-07-24 psargent-->Replace jpeg images in prospecting_image with OpenStreetMaps data
<dd><!--2020-05-01 psargent-->This whole subsystem needs a good examination and possible rewriting. :expoweb:/noinfo/prospecting_guide_scripts
@ -120,7 +121,6 @@ If a heading is in italics, then there are hidden items.
<dt><!--2020-03-26 psargent-->Troggle architecture</dt>
<dd><!--2020-03-26 psargent-->Handbook: add package diagram totroggle architecture documentation. For future system maintainers</dd>
<dd><!--2020-04-10 psargent-->Regenerate the diagram of the tables in the database & document</dd>
<dd><!--2020-04-10 psargent-->Describe the parsing/import procedures so non-nerds can do it</dd>
<dd><!--2020-03-26 psargent-->Copy [some of] the .wiki material into the documentation somewhere?</dd>
@ -142,23 +142,40 @@ If a heading is in italics, then there are hidden items.
<h3>Troggle</h3>
<dl>
<dt>Better import error messages
<dd><!--2020-04-03 psargent-->REPORT if import surveyscan file failure into database error log -> "DataIssue" register
<dd><!--2020-04-20 psargent-->REPORT 'folder not recognised' errors into error log inside database -> "DataIssue" register
<dd><!--2020-04-03 psargent-->WHY are total lengths of surveyed cave different between expo server and WSL server for 2019 and a few other years only ?
<dd><!--2020-04-20 psargent-->DEBUG - too many messages - reduce the number unless we need them
<dd><!--2020-05-14 psargent-->FIND where that default cave print __unicode__() is happening
<dt>Missing .3d files
<dd><!--2020-04-25 psargent-->REPORT if there is no .3d file - make it if it is not there ? O rjust leave it to Makefile ?
<dt><!-- 2020-04-11 psargent -->Troggle parser/viewer
<dd>Explain how FLATPAGES work. refer to computing/hbmanual1.html
<dt>Logbook data model: unfilled fields?
<dd><!--2020-04-03 psargent-->'cave' of location field missing on nearly all logbook entries. Missing from logbook templates. Fill in manually for pre-2017 logbooks.
<dt><!--2020-07-24 psargent--> Completely new design of QM management needed
<dd><!--2020-07-24 psargent-->see <a href="../troggle/scriptsqms.html">QM status and redesign needed document</a>
<dt><!--2020-07-24 psargent--> jQuery version and remove all unused CSS and JS files
<dd><!--2020-07-24 psargent-->jQuery used for Edit This Page very very VERY out of date. Reinstate TinyMCE too ?
<dt><!--2020-07-24 psargent--> 19 names don't work in folk/troggle
<dd><!--2020-07-24 psargent-->there are 3 separate name parsers: in the folk script, and two in different bits of troggle.
<dt><!--2020-07-24 psargent--> Django migrations documentation needed
<dd><!--2020-07-24 psargent-->How to upgrade python version, django version, django-plugins versions, pip install and useful/essential tools such as python -Wall manage.py check -v 3.
<dd><!--2020-07-24 psargent-->django-estensions usefulness. Explain/document why troggle still needs database migraitons even though we rebuild it afresh each time
</dl>
<h3>Troggle Refactoring</h3>
<dl> <dt><!--2020-07-24 psargent-->Make parsers use generators to yield one line at a time
<dd><!--2020-07-24 psargent-->Both recursive load and linear load parsers/survex could do this.
<dd><!--2020-07-24 psargent-->In the logbooks parsing and cache loading.
<dt><!--2020-07-24 psargent-->Replace assert() with dataIssue [NOTIFICATION pattern] or Exceptions
<dd><!--2020-07-24 psargent-->https://martinfowler.com/articles/replaceThrowWithNotification.html
<dt><!--2020-07-24 psargent-->Python documentation: Django's use of modern unobvious idioms
<dd><!--2020-07-24 psargent-->[DECORATOR] pattern used for login-required pages
<dd><!--2020-07-24 psargent-->Get all trogglistas to read https://ebookscart.com/effective-python-by-brett-slatkin-pdf-download/ - downloded to /expofiles/
<dd><!--2020-07-24 psargent-->Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
<dt><!--2020-07-24 psargent-->Flatfiles is used to deliver CSS and JS for django admin pages,
<dd><!--2020-07-24 psargent-->staticfiles django plugin broken, not needed so use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working
</dl>
<h3>Expo Server</h3>
<dl>
<dt><!--2020-07-24 psargent--> document cgit installation and config
<dd><!--2020-07-24 psargent-->as per Wookey on new server Debian 10
<dt><!--2020-03-26 psargent--> document directory structure
<dd><!--2020-04-03 psargent-->as per Julian's GitHub list - then close that issue.
Use 'tee' to cretae ascii art for this.</dd>
@ -171,9 +188,9 @@ If a heading is in italics, then there are hidden items.
<dd><!--2020-04-03 psargent-->DOCUMENT How to set up a server
<dd><!--2020-04-10 psargent-->Fix and document permissions for cron jobs
<dd><!--2020-05-14 psargent-->Document "anacron" / cron system on server
<dd><!--2020-04-10 psargent-->Explain why Docker containers can be a maintenance nightmare
<dd><!--2020-04-10 psargent-->Explain why Docker containers can be a maintenance nightmare unless built from a script
<dd><!--2020-04-25 psargent--> /expofiles/ needs config , refer to apache/django docm.
<dd><!--2020-04-25 psargent--> /static/ needs config - refer to django docm.
<dd><!--2020-04-25 psargent--> admin/doc/ BROKEN PAGE needs config - refer to django docm.
</dl>