- From: Harshvardhan J. Pandit <me@harshp.com>
- Date: Thu, 21 Jan 2021 08:32:16 +0000
- To: Beatriz Esteves <besteves@delicias.dia.fi.upm.es>
- Cc: Data Privacy Vocabularies and Controls Community Group <public-dpvcg@w3.org>
Hi Beatriz, All. In the last call, Beatriz mentioned some typos/errors in the documentation that need to be fixed. I'm outlining here the general process to do so. DPV documentation is generated from the code in this repo: https://github.com/dpvcg/dpv-documentation It is a bunch of python scripts that download CSV from the Google Sheets document (001), convert it to RDF (002), and generate HTML documentation (003). Depending on where the error originates, the appropriate script or source should be changed. For e.g., if it is a typo in the rdfs:label or dct:description of a concept, the error is likely to be in the Google sheet. To fix this, the changes should be made in Google Sheets, and all scripts (001-003) should be executed. If it is a typo in the HTML generated, e.g. format or header is incorrect, then the appropriate template must be changed, and script 003 must be executed. For DPV, the HTML is generated from this template https://github.com/dpvcg/dpv-documentation/blob/master/jinja2_resources/template_dpv.jinja2 The generated files are by default stored within the same folder/repo, and need to copied over to the DPV repo OR you can change the output path in the scripts. There is also an opportunity to use SHACL to validate concepts have required annotations e.g. label, dates. The GitHub README lists all of these points in greater detail. If anything is unclear or there are suggestions, do let me know. Alternative if this is too technical: open a PR on GitHub, or send an email to the mailing list. P.S. All of this esoteric design has a good reason, e.g. less reliance on Google Sheets by using CSV, local copies for testing, and clear separation of 'live' vocabulary files. Regards, -- --- Harshvardhan J. Pandit, Ph.D Research Fellow ADAPT Centre, Trinity College Dublin https://harshp.com/
Received on Thursday, 21 January 2021 08:33:22 UTC