geolexica / isotc211-glossary

ISO/TC 211 MLGT Online Concepts
2 stars 8 forks source link

Important note about the status of this repository as backend for glossary management software #10

Open strogonoff opened 4 years ago

strogonoff commented 4 years ago

There is software that relies on this repository as principal internal data storage. Software is used to browse registry data and to file/review/resolve change requests.

There are some implications:

  1. There is a commit coming where the data in this repository will be overwritten by the app, with YAML serialized in Node’s js-yaml fashion. This will be a one-time big diff.

  2. After a registry/glossary management app starts being used in production by a customer, legacy data migration script cannot overwrite the repository anymore. This can generate unrelated diffs and possibly cause users to encounter merge conflicts while operating the app.

  3. mlgt-data submodule will be removed (this is already in a PR). We want Git operations performed by software to be as smooth as possible to the user, so we don’t want it to download binary blobs that are not needed for app to function.

  4. Software branding will be added (this is already in a PR).

strogonoff commented 4 years ago

Timeline for production use is next week, and YAML will be rewritten some time this week.