From deccd80ddfad65f9e31e33f0360bfc9e1fa793f5 Mon Sep 17 00:00:00 2001 From: Noccy Date: Wed, 2 Nov 2022 10:48:07 +0000 Subject: [PATCH] Update 'Best Practices' --- Best-Practices.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 Best-Practices.md diff --git a/Best-Practices.md b/Best-Practices.md new file mode 100644 index 0000000..84342f7 --- /dev/null +++ b/Best-Practices.md @@ -0,0 +1,37 @@ +## Using data + +### Docker + +When using Docker, it is ideal to run the import routines during the build process, or possibly in the entrypoint. + +### Bundling datasets + +It is possible to add the .zip packages of the datasets to your repository, as long as you add the directory as an artifact repository in your composer.json: + +```json +{ + ... + "repositories": [ + { "type": "artifact", "url": "dist/packages" } + ], + ... +} + +``` + +## Datasets + +### Versioning + +As the data in most datasests is considered fresh at the time of packaging, the version numbers really should reflect when the data was prepared. We have decided on the year as minor version for our packages, leaving the major version for updates that may break schemas. + +**Recommended format:** + +``` + 0.22.10.4 + | | | |__ Revision + | | |_____ Month of build + | |________ Year or build + |__________ Data format revision +``` +