w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2026-09-24 16:24:32 +00:00
Code Issues 13 Packages Projects Releases Wiki Activity

Rationalise docs part 2 #151

Browse Source
This commit is contained in:
Ian Renton
2026-09-23 17:42:06 +01:00
parent b45a6d8b78
commit c9d0a7652c
16 changed files with 44 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
templates/help/about.html
-2
View File
@@ -13,8 +13,6 @@
source, freeing developers from needing to know how each individual data source presents its data.</p>
<p>Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. <a
href="https://git.ianrenton.com/ian/spothole/">The source code is here</a>.</p>
<p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a> with code contributions by
Steven, M1SDH. The full list of thanks due to others can be found at the bottom of this page.</p>
<p>This server is running Spothole version {{software_version}}.</p>
{% end %}
templates/help/accuracy.html
+5 -5
View File
@@ -1,7 +1,7 @@
{% extends "help_page.html" %}
{% block help_content %}
<h2 id="accuracy" class="mt-4">Data Accuracy</h2>
<h2 class="mt-4">Data Accuracy</h2>
<p>Please note that the data coming out of Spothole is only as good as the data going in. People mis-hear and make
typos when spotting callsigns all the time. There are also plenty of cases where Spothole's data, particularly
location data, may be inaccurate. For example, there are POTA parks that span multiple US states, countries that
@@ -9,9 +9,9 @@
accuracy is important, such as contesting, you should not rely on Spothole's data to fill in any gaps in your
log.</p>
<p>In the Spothole user interface, under "Your Data", you can enter your credentials for QRZ.com and/or HamQTH if
you have them. This allows Spothole to augment its data with lookups from these services. See the following
section, Privacy, for details of how these are handled. If you are looking at the map and see lots of spots in
the geographic centre of countries, allowing these lookups will help. For QRZ.com a paid account is required to
look up operator locations.</p>
you have them. This allows Spothole to augment its data with lookups from these services. See the <a
href="/help/privacy">Privacy</a> section for details of how these are handled. If you are looking at the
map and see lots of spots in the geographic centre of countries, allowing these lookups will help. For QRZ.com a
paid account is required to look up operator locations.</p>
{% end %}
templates/help/faq.html
+1 -1
View File
@@ -1,7 +1,7 @@
{% extends "help_page.html" %}
{% block help_content %}
<h2 id="faq" class="mt-4">FAQ</h2>
<h2 class="mt-4">FAQ</h2>
<h4 class="mt-4">"Spots"? "DX Clusters"? What does any of this mean?</h4>
<p>This is a tool for amateur ("ham") radio users. Many amateur radio operators like to make contacts with others
who are doing something more interesting than sitting in their home "shack", such as people in rarely-seen
templates/help/help_page.html
+2 -2
View File
@@ -3,12 +3,12 @@
<div id="info-container" class="mt-4">
<p class="small mb-0"><a href="/help">Spothole Help</a></p>
{% block help_content %}{% end %}
{% block help_content %}{% end %}
<p class="small mt-4"><a href="/help">Back</a></p>
</div>
<script>$(document).ready(function () {
$("#nav-link-about").addClass("active");
$("#nav-link-help").addClass("active");
}); <!-- highlight active page in nav --></script>
{% end %}
templates/help/index.html
+6 -2
View File
@@ -2,11 +2,15 @@
{% block content %}
<div id="info-container" class="mt-4">
<h2 class="mt-4 mb-4">Spothole Help</h2>
<p>Welcome to Spothole's help pages.</p>
<p>Spothole is a utility to aggregate spots from amateur radio DX clusters and xOTA spotting sites, and provide an
open JSON API as well as a website to browse the data.</p>
<p>In the sections below, you can find more information about what Spothole is, and how to use it.</p>
<ul>
<li><a href="/help/about">About Spothole</a></li>
<li><a href="/help/using">How To Use Spothole</a></li>
<li><a href="/help/faq">FAQ</a></li>
<li><a href="/apidocs">OpenAPI Specification</a></li>
<li><a href="/help/accuracy">Data Accuracy</a></li>
<li><a href="/help/privacy">Privacy</a></li>
<li><a href="/help/thanks">Thanks</a></li>
@@ -14,7 +18,7 @@
</div>
<script>$(document).ready(function () {
$("#nav-link-about").addClass("active");
$("#nav-link-help").addClass("active");
}); <!-- highlight active page in nav --></script>
{% end %}
templates/help/privacy.html
+1 -1
View File
@@ -1,7 +1,7 @@
{% extends "help_page.html" %}
{% block help_content %}
<h2 id="privacy" class="mt-4">Privacy</h2>
<h2 class="mt-4">Privacy</h2>
<p>Spothole collects no data about you on a permanent basis. All spots and alerts are "timed out" and deleted from
the system after a set interval, which by default is one hour for spots and one week for alerts.</p>
<p>Settings you select from Spothole's menus are sent to the server, in order to provide the data with the requested
templates/help/thanks.html
+2
View File
@@ -2,6 +2,8 @@
{% block help_content %}
<h2 class="mt-4">Thanks</h2>
<p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a> with code contributions by
Steven, M1SDH.</p>
<p>This project would not have been possible without those volunteers who have taken it upon themselves to run DX
clusters, xOTA programmes, DXpedition lists, callsign lookup databases, solar conditions and propagation
modelling software, and other online tools on which Spothole's data is based. The vast majority of these are not
templates/help/using.html
+6 -5
View File
@@ -1,7 +1,7 @@
{% extends "help_page.html" %}
{% block help_content %}
<h2 class="mt-4 mb-4">Using Spothole</h2>
<h2 class="mt-4 mb-4">How to Use Spothole</h2>
<p>There are a number of different ways to use Spothole, depending on what you want to do with it and your level of
technical skill:</p>
<ol>
@@ -25,10 +25,11 @@
</li>
{% end %}
<li>You can <b>write your own client using the Spothole API</b>, using the main Spothole instance to provide
data, and do whatever you like with it. The README contains guidance on how to do this, and the full API
docs are linked above. You can also find reference implementations in the form of Spothole's own web-based
front end, plus my other two tools built on Spothole: <a href="https://fieldspotter.radio">Field Spotter</a>
and the <a href="https://qsomap.m0trt.radio">QSO Map Tool</a>.
data, and do whatever you like with it. The help section contains guidance on how to do this, and the full
API docs can be found <a href="/apidocs">here</a>. You can also find reference implementations in the form
of Spothole's own web-based front end, plus my other two tools built on Spothole: <a
href="https://fieldspotter.radio">Field Spotter</a> and the <a href="https://qsomap.m0trt.radio">QSO
Map Tool</a>.
</li>
<li>If you want to <b>run your own version of Spothole</b> so you can customise the configuration, such as
enabling sources that I disable on the main instance, you can do that too. The README contains not only