+1. I think that an external README.md is a good practice. I advise against documenting data in source code because the data could be used by other sources. I think our existing text file provenance information to Markdown is a good idea because links to original sources become navigable.
Kind regards, Ben. On 01/07/16 03:49, Jody Garnett wrote: > I would add a README.md to the module, quoting where you got the data from > and the permission obtained. > > We originally gathered up everything into files like this > https://github.com/geotools/geotools/blob/master/modules/plugin/epsg-hsql/src/site/apt/review.apt > > I would like to turn all of these into README.md or REVIEW.md files as has > been done here > https://github.com/geotools/geotools/tree/master/modules/library/cql > > The best examples of "where the data came from" are in GeoServer here: > https://github.com/geoserver/geoserver/blob/master/data/release/README.rst > > > -- > Jody Garnett > > On 30 June 2016 at 03:41, Daniele Romagnoli < > daniele.romagn...@geo-solutions.it> wrote: > >> Hi List, >> I have a sample netcdf (let's call it sample_x.nc) and I got >> authorization to use it on my tests provided I'm referencing this license: >> http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/ >> >> I'm going to create a pull request to add support for such a type of data >> and I would like to include that sample data in >> src/test/resources/my.package/test-data. >> >> (I have already reduced the original sample data through NetCDF operators >> so it is some KB instead of the original 12 MB). >> >> My questions are: >> what is the general approach to include those samples? >> Should I add a sample_x.nc.license containing the above URL plus a minimal >> description? >> Should I add that URL into a comment of the TestJava class too? >> Should I simply add a license.txt listing the sample in use and the >> related license? >> >> Please, let me know what approach should I follow. >> I would like to prepare the pull request before the end of the day. >> If I don't receive any feedbacks in the meantime (due to timezone >> differences or devs being busy) I will start with the approach of putting a >> reference in both TestJava class and within a sample_x.nc license. >> However, I would be happy to re-arrange that based on your feedbacks. >> >> Cheers, >> Daniele >> >> >> -- >> == >> GeoServer Professional Services from the experts! Visit >> http://goo.gl/it488V for more information. >> == >> >> Ing. Daniele Romagnoli >> Senior Software Engineer >> >> GeoSolutions S.A.S. >> Via di Montramito 3/A >> 55054 Massarosa (LU) >> Italy >> phone: +39 0584 962313 >> fax: +39 0584 1660272 >> >> http://www.geo-solutions.it >> http://twitter.com/geosolutions_it >> >> ------------------------------------------------------- >> >> *AVVERTENZE AI SENSI DEL D.Lgs. 196/2003* >> >> Le informazioni contenute in questo messaggio di posta elettronica e/o >> nel/i file/s allegato/i sono da considerarsi strettamente riservate. Il >> loro utilizzo è consentito esclusivamente al destinatario del messaggio, >> per le finalità indicate nel messaggio stesso. Qualora riceviate questo >> messaggio senza esserne il destinatario, Vi preghiamo cortesemente di >> darcene notizia via e-mail e di procedere alla distruzione del messaggio >> stesso, cancellandolo dal Vostro sistema. Conservare il messaggio stesso, >> divulgarlo anche in parte, distribuirlo ad altri soggetti, copiarlo, od >> utilizzarlo per finalità diverse, costituisce comportamento contrario ai >> principi dettati dal D.Lgs. 196/2003. >> >> >> >> The information in this message and/or attachments, is intended solely for >> the attention and use of the named addressee(s) and may be confidential or >> proprietary in nature or covered by the provisions of privacy act >> (Legislative Decree June, 30 2003, no.196 - Italy's New Data Protection >> Code).Any use not in accord with its purpose, any disclosure, reproduction, >> copying, distribution, or either dissemination, either whole or partial, is >> strictly forbidden except previous formal approval of the named >> addressee(s). If you are not the intended recipient, please contact >> immediately the sender by telephone, fax or e-mail and delete the >> information in this message that has been received in error. The sender >> does not give any warranty or accept liability as the content, accuracy or >> completeness of sent messages and accepts no responsibility for changes >> made after they were sent or for other risks which arise as a result of >> e-mail transmission, viruses, etc. >> >> >> >> ------------------------------------------------------------------------------ >> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San >> Francisco, CA to explore cutting-edge tech and listen to tech luminaries >> present their vision of the future. This family event has something for >> everyone, including kids. Get more information and register today. >> http://sdm.link/attshape >> _______________________________________________ >> GeoTools-Devel mailing list >> GeoTools-Devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/geotools-devel >> >> > > > > ------------------------------------------------------------------------------ > Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San > Francisco, CA to explore cutting-edge tech and listen to tech luminaries > present their vision of the future. This family event has something for > everyone, including kids. Get more information and register today. > http://sdm.link/attshape > > > > _______________________________________________ > GeoTools-Devel mailing list > GeoTools-Devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/geotools-devel > -- Ben Caradoc-Davies <b...@transient.nz> Director Transient Software Limited <http://transient.nz/> New Zealand ------------------------------------------------------------------------------ Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San Francisco, CA to explore cutting-edge tech and listen to tech luminaries present their vision of the future. This family event has something for everyone, including kids. Get more information and register today. http://sdm.link/attshape _______________________________________________ GeoTools-Devel mailing list GeoTools-Devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geotools-devel
