Merge remote-tracking branch 'upstream/master'

[nominatim-ui.git] / dist / theme / about-help.html

diff --git a/dist/theme/about-help.html b/dist/theme/about-help.html
index aa0d15d262990ac38617c44af38f74b0415db43f..0f5256233cc0098236ca14ea56cba846321bc38d 100644 (file)
--- a/dist/theme/about-help.html
+++ b/dist/theme/about-help.html
@@ -1,25 +1,65 @@
 <h2 class="my-4">About & Help</h2>
 
 <p>
 <h2 class="my-4">About & Help</h2>
 
 <p>

-  This website is based on <a href="https://github.com/osm-search/nominatim-ui">Nominatim UI</a>,
-  a debugging interface for the <a href="https://nominatim.org/">Nominatim</a> geocoding software.
+  Nominatim is a search engine for <a href="https://www.openstreetmap.org/">OpenStreetMap</a> data.
+  You may search for a name or address (forward search) or look up data by its geographic coordinate
+  (reverse search). Each result comes with a link to a details page where you can inspect what data
+  about the object is saved in the database and investigate how the address of the object has been
+  computed.

 </p>
 
 <p>
 </p>
 
 <p>

-  The Nominatim API is installed at <code>Nominatim_API_Endpoint</code> and for questions you
-  should contact their administrators.
+  This website is the debugging interface for the
+  <a href="https://nominatim.openstreetmap.org">Nominatim search service</a>
+  used by the <a href="https://openstreetmap.org">OpenStreetMap website</a>.

 </p>
 
 </p>
 

+<h3>Documentation</h3>
+

 <p>
 <p>

-  Nominatim is a search engine for <a href="https://www.openstreetmap.org/">OpenStreetMap</a> data.
-  You may search for a name or address (forward search) or look up data by its geographic coordinate
-  (reverse search). Each result comes with a link to a details page where you can inspect what data
-  about the object is saved in the database and investigate how the address of the object has been
-  computed.
+  API documentation can be found at the
+  <a href="https://nominatim.org/release-docs/develop/api/Overview/">Nominatim website</a>.
+  This instance usually runs the latest version of the software and uses
+  up-to-date data from OpenStreetMap.

 </p>
 
 </p>
 

+<p>
+  Please read the <a href="https://operations.osmfoundation.org/policies/nominatim/">Usage Policy</a>
+  before using the API for your own website or software.
+</p>

 
 

-<p class="alert alert-secondary my-4">
-  If you're the adminstrator of this website you can edit the text above in
-  <code>dist/theme/about-and-help.html</code>
+<h3>Report a problem</h3>
+
+<p>
+  There is a 
+  <a target="_blank" href="https://nominatim.org/release-docs/develop/api/Faq/">FAQ</a>
+  for commonly asked questions. For general questions about OpenStreetMap data,
+  please use <a href="https://help.openstreetmap.org">OSM Help</a>.
+</p>
+<p>
+  Use <a target="_blank" href="https://github.com/osm-search/Nominatim/issues">Nominatim issues on github</a>
+  to report problems.
+</p>
+<p>
+  Please ensure that you include a full description of the problem, including the search
+  query that you used, the problem with the result and, if the problem relates to missing data,
+  the osm type (node, way, relation) and id of the item that is missing.
+</p>
+<p>
+  Problems that contain enough detail are likely to get looked at before ones that require
+  significant research.
+</p>
+
+<h3>Source code</h3>
+
+<p>
+  This website is based on <a href="https://github.com/osm-search/nominatim-ui">Nominatim UI</a>,
+  a debugging interface for the <a href="https://nominatim.org/">Nominatim</a> geocoding software.
+</p>
+
+<h3>Privacy policy</h3>
+
+<p>
+  This site and the API are subject to the
+  <a href="https://wiki.osmfoundation.org/wiki/Privacy_Policy">OSMF privacy policy</a>.

 </p>
 </p>