search

riparias / gbif-alert

GBIF Alert is a GBIF occurrence based alert system.
https://gbif-alert-demo.thebinaryforest.net/
MIT License
8 stars 2 forks source link

Document the expected structure and format of custom areas files #253

Closed damianooldoni closed 1 year ago

damianooldoni commented 1 year ago

I tested the upload area tool with a geopackage containing one element in one layer. Trying to upload a geopacakge with two elements in one layer failed with a verbose and not really user-friendly message, see screenshot at the end of the issue. The title is quite clear to me, but maybe not for everybody? I would also apply a defensive programming strategy so that the system fails nicely with a shorter and nicer error message instead of showing all details and traceback.

I think we should add a text mentioning:

  1. Which file formats are supported. At least list the most common you are sure about it.
  2. How many layers and how many elements the file should contain.

@niconoe: maybe the list above is not complete? Feel free to add more info if you think it's needed.

IMO showing this text on the my custom areas page is enough. If too long, we could bundle it in a "custom area file requirements" document visualized as a pop up? If a pop up is too much work, we can opt for a link to a GitHub page.

image

niconoe commented 1 year ago

Hey @damianooldoni: all that is planned: the current error handling / polishing / design of the page is not good enough (that's why the page is hidden on the production site), I plan to largely improve all this at the end of August or early september!

niconoe commented 1 year ago

That was done (directly on the "my custom areas" page)