Open pzermoglio opened 5 years ago
The current location of the documents on labs.gbif.org
is temporary, but with a final document at https://labs.gbif.org/documents/openrefine-guide/ then the primary place for the data (for people viewing the document) is next to it, at https://labs.gbif.org/documents/openrefine-guide/data/EjercicioModelo_OpenRefine_Datos.zip
Like all other parts of the document (text, images), that file is part of the document and should therefore be in Github. It can then be versioned and edited (in the future you may add an extra column to teach an additional feature), and won't be lost.
links.gbif.org
is our URL shortener, like tinyurl.com
. The only reason to use that is if people often need to type in the URL, for example if they only have a paper copy of the document. This seems unlikely, so it's probably not necessary. If it is necessary, I'd expect the links.gbif.org
link to point to https://labs.gbif.org/documents/openrefine-guide/data/EjercicioModelo_OpenRefine_Datos.zip
Some documents rely on separate files for some purposes (e.g., guide to use of OpenRefine requires a separate csv data file to run the examples shown in the guide).
In the documentation these separate files are usually linked and could point to:
For consistency and persistence, should there be a recommendation for authors to always set at least one copy of such files in the GH repo and link to those?