From a7f871ca98a94a424169eca7b32b384ddb50b9b6 Mon Sep 17 00:00:00 2001 From: gwen Date: Thu, 24 Aug 2023 17:44:01 +0200 Subject: [PATCH] description du git subtree dans la doc --- actes-princiers/docs/source/data.rst | 55 ++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/actes-princiers/docs/source/data.rst b/actes-princiers/docs/source/data.rst index 0a55c28..2f90e59 100644 --- a/actes-princiers/docs/source/data.rst +++ b/actes-princiers/docs/source/data.rst @@ -135,3 +135,58 @@ Identifiants - L'identifiant des actes (`@xml:id` de ``) est composé des trois éléments séparés d'un underscore et suivi de la date et d'une lettre. - Actes de Charles Ier de Bourbon du 28 août 1427 : `brb_ch_i_1427_08_24a`. + + +Les datas dans le projet `princely-acts` +-------------------------------------------- + +Les datas dans le projet `princely-acts` sont centralisées dans un seul projet, le projet + +.. glossary:: + + data registry + + Un data registry est storage de data centralisé, qui fait office de référentiel de données. Ce référentiel peut être alors utilisé partout ailleurs dans les autres projets qui ont besoin d'utiliser les datas **en lecture**. + +.. note:: Dans le projet `princely-acts`, le référentiel de données s'appelle `princely-acts/data` et est un dépôt git. + + +Pour réutilser les données par exemple dans le projet `princely-acts/datascience`, on peut : + +- soit faire un lien symbolique si on est sous linux +- soit (cette pratique est préférable), utiliser la fonctionnalité + `git subtree `_ de git, puisque nous utilisons git comme data registry. + +Git subtree +---------------- + +Voici la procédure d'import des datas depuis le dépôt `princely-acts/data` +vers le dépot `princely-acts/datascience` par exemple : + +- aller dans le dépôt `princely-acts/datascience` +- ajouter **à la racine du projet** le remote suivant : + +:: + + datascience $ git remote add data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git + +- vérifiez que le remote a bien été ajouté avec la commande : + +:: + + datascience $ git remote -v + data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (fetch) + data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (push) + origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (fetch) + origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (push) + +- ensuite, vous pouvez ajouter le subtree qui va pointer sur les datas + avec la commande suivante (placez-vous toujours à la racine du projet) + +:: + + datascience $ git subtree add --prefix actes-princiers/data/01_raw data main --squash + +.. important:: Il faut que le dossier `actes-princiers/data/01_raw` n'existe pas (ne soint pas présent) dans le projet `datascience`, sinon le pull ne va fonctionner. + +- Vous pouvez ensuite utiliser les datas du projet `data` depuis le projet `datascience`.