test round 1 cleanup

indexing/workflow/README.md

@@ -0,0 +1,34 @@
+README in `bildersammlung-buddhismus-public/indexing/workflow`.
+
+## Overview
+
+Semi-automated workflow on `students` branch to collaborate on Tropy project to index the collection. 
+
+## Creator
+
+This dataset was created by the University of Basel's Research and Infrastructure Support RISE ([email protected]) in 2023. The automation script was forked from @sorinmarti.
+
+## Overview 
+
+### Setup
+
+- All users set up a given project with Tropy with all image assets on their machine. [Instructions here.](https://github.com/RISE-UNIBAS/bildersammlung-buddhismus-public/tree/main/indexing#how-to-use-this-tropy-project)
+- Every user exports their project as JSON-LD and stores it in `/indexing/workflow/to_download` as `export_name` where "name" is the user's name.
+- The course admins export the most recent version of `/indexing/indexing.tpy` as `/indexing/workflow/export_master.json`. NB: `export_master.json` must contain a dummy item with values for all indices, otherwise indices without values will not be added to metadata manifest of the export (this can lead to problems with the automated updates).
+
+### Workflow
+
+- Users can add metadata to their project:
+  - Users update their project and commit one or more JSON-LD export files to `/indexing/workflow/user_export` and push it.
+  - An action (see `/.github/workflows/main.yml`) runs a script (see `/indexing/workflow/update_master_export.py`) which:
+    - Reads all the changes and writes them to `/indexing/workflow/export_master.json`.
+    - All files in `/indexing/workflow/to_download` get updated with the new information (keeping the original user dependent image paths).
+    - Updated information is logged in `/indexing/workflow/logs/master_log.txt`.
+    - The committed file(s) in `/indexing/workflow/user_export` folder get moved to `/indexing/workflow/export_archive`.
+  - Now users can update their project and have the latest data as JSON-LD export with their paths intact.
+
+## To dos
+
+- [ ] Check if updates in `/indexing/workflow/to_download` are needed resp. run correctly.
+- [ ] Streamline documentation
+- [ ] Add test.