Some metadata could be in git repository about serenata-de-amor HOT 4 CLOSED

Hi @josircg, that's a question I asked myself when finishing the related pull request. The reason why I put it in the gitignored folder is because the documentation belongs to an specific version of the datasets (versioned by the date in the file name). In the same way we don't commit datasets (since we will soon have many version of different datasets), we're not committing their documentation.

For addressing your use case, I would add the dataset documentation (contained in the data/YYYY-MM-DD-ceap-datasets.md in Jarbas' web interface. Would that help you?

from serenata-de-amor.

Good point too, @Irio. Gonna add this Issue to Jarbas and close this one here on Serenata — is that ok?

from serenata-de-amor.

Hi @josircg!

Good point. For those working with data analysis it is supposed to be in data/2016-08-08-ceap-datasets.md — this file is created by src/translation_table.py, as described in our contributing guide.

However, for those just verifying the suspect documents/receipts, for those working with communication, and for anyone not running the full data science stack this file could be more accessible.

What do you all think about two possibilities:

• Linking the original source in Portuguese in Jarbas and in this repo (letting the reader to deduce our translation)
• Saving 2016-08-08-ceap-datasets.md outside the data/ adding it to the repo (and, if so, where should we place it, and how to name it)

from serenata-de-amor.

For an end-user, the link to the original source in Portuguese in Jarbas web interface would be suffice.

The developer will get the .md file when he/she download the dataset.

from serenata-de-amor.