bilara-data icon indicating copy to clipboard operation
bilara-data copied to clipboard

naming convention for blurbs

Open sujato opened this issue 3 years ago • 3 comments

Currently blurb files use two naming conventions:

  1. uid-blurbs_root-en.json
  2. uid-blurbs_root-en-blurb.json

The former is used for the root, the latter for the pt blurbs, while de blurbs have both.

Strangely, the blurbs that appear on bilara include both forms, even when they do not exist in bilara-data; there are 12 de-blurb files in bilara-data, and 27 on bilara. Disconcerting!

First we need to settle on a form for the file names.

Form 1 has the advantage of brevity. But form 2 is consistent with other site naming, where we have eg. foo_translation-de-site.json or foo_root-en-name.json.

So I guess that for the sake of consistency we should standardize on form 2?

This would mean that:

  • [ ] root blur files should be renamed
  • [ ] de blurbs have duplicates deleted
  • [ ] ensure that the same files are present on bilara and bilara-data

sujato avatar Sep 04 '21 22:09 sujato

Strangely, the blurbs that appear on bilara include both forms, even when they do not exist in bilara-data; there are 12 de-blurb files in bilara-data, and 27 on bilara. Disconcerting!

This, I think, comes because in bilara-data, a new file is only created when a translation has started. So bilara-data shows all blurb files where translations have been made, while Bilara has all blurb files.

By today (Oct 24), there are 15 files in bilara-data "unpublished" and 12 in "published", which will change as soon as I press the "publish" button.

So I guess that for the sake of consistency we should standardize on form 2?

That's what I'd also guess. But note that form 1 is the older one and has been created first, and it is this one that, in the case of duplicates, has the German translations. Those should not get lost in the process of deleting them!!! :warning:

root blur files should be renamed de blurbs have duplicates deleted ensure that the same files are present on bilara and bilara-data

I'd still like to add: Please notify Sabbamitta before starting work on this to give her a chance for synchronizing the "unpublished" and "published" branches and stopping making more edits to the files. :pray:

sabbamitta avatar Oct 24 '21 07:10 sabbamitta

The form with no extra blurb is correct.

sujato avatar Oct 25 '21 09:10 sujato

In this case, there are still a few files that need some attention.

  • iti-blurbs_translation-de-blurb has already some German translation and has no counterpart without the extra "blurb".
  • ud-blurbs_translation-de-blurb the same.
  • snp-blurbs_translation-de-blurb the same.
  • pli-tv-bu-vb-blurbs_translation-de-blurb has some translation and has a counterpart without the extra "blurb". So here it would be easy for me to just copy the translated segments to the other file, as they are not yet many.
  • pli-tv-bu-pm-blurbs_translation-de-blurb the same—however, for the two latter files we still have the other problem described in this issue: https://github.com/suttacentral/bilara-data/issues/1061

sabbamitta avatar Oct 25 '21 09:10 sabbamitta