update report a problem page

[nominatim.git] / lib / template / includes / report-errors.php

diff --git a/lib/template/includes/report-errors.php b/lib/template/includes/report-errors.php
index 05a47c8b28de1832b751f8539aceb4503a222bf7..c5dc1e7f8250340e4e4d3493e2bc38435c09f35f 100644 (file)
--- a/lib/template/includes/report-errors.php
+++ b/lib/template/includes/report-errors.php
@@ -1,24 +1,42 @@
 <p>
-    Before reporting problems please read the <a target="_blank" href="https://wiki.openstreetmap.org/wiki/Nominatim">user documentation</a>
-    and
-    <a target="_blank" href="https://wiki.openstreetmap.org/wiki/Nominatim/FAQ">FAQ</a>.
+    Before reporting problems please read the <a target="_blank" href="https://nominatim.org/release-docs/develop/api/Overview">user documentation</a>.
+
+    <h4>Finding the expected result</h4>
+
+    First of all, please make sure that the result that you expect is
+    available in the OpenStreetMap data.
+
+    To find the OpenStreetMap data, do the following:
+
+    <ul>
+     <li>Go to <a href="https://openstreetmap.org">https://openstreetmap.org</a>.</li>
+     <li>Go to the area of the map where you expect the result
+         and zoom in until you see the object you are looking for.</li>
+     <li>Click on the question mark on the right side of the map,
+         then with the question cursor on the map where your object is located.</li>
+     <li>Find the object of interest in the list that appears on the left side.</li>
+     <li>Click on the object and note down the URL that the browser shows.</li>
+    </ul>
+
+    If you cannot find the data you are looking for, there is a good chance
+    that it has not been entered yet. You should <a href="https://www.openstreetmap.org/fixthemap">report or fix the problem in OpenStreetMap</a> directly.
+
+    <h4>Reporting bad searches</h4>
+
+    Problems may be reported at the <a target="_blank" href="https://github.com/openstreetmap/nominatim/issues">issue tracker on github</a>. Please read through
+    the open tickets first and check if your problem has not already been
+    reported.
+
+    When reporting a problem, include the following:
+
+    <ul>
+      <li>A full description of the problem, including the exact term you
+          were searching for.</li>
+      <li>The result you get.</li>
+      <li>The OpenStreetMap object you expect to find (see above).</li>
+    </ul>
+
+    For general questions about installing and searching in Nominatim, please
+    use <a href="https://help.openstreetmap.org/tags/nominatim/">Help OpenStreetMap</a>.
 
-    If your problem relates to the address of a particular search result please use the 'details' link 
-    to check how the address was generated before reporting a problem.
-</p>
-<p>
-    Use <a target="_blank" href="https://github.com/openstreetmap/nominatim/issues">Nominatim issues on github</a>
-    to report problems.
-<!-- You can search for existing bug reports
-    <a href="https://trac.openstreetmap.org/query?status=new&amp;status=assigned&amp;status=reopened&amp;component=nominatim&amp;order=priority">here</a>.</p>
- -->
-</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>