add/update readmes of each folder

Author: M-Busk

catalog-shapes/README.md

@@ -0,0 +1,21 @@
+# MERLOT Dataspace shape and ontology files
+This folder contains all the shape and ontology files that are used within the MERLOT marketplace.
+
+## Shapes
+
+The shape files contain the description of the data structure of a particular type as well as what constrains lie on each field.
+
+The `shapes` folder is split into the shapes based on the Gaia-X (Tagus + partially Loire) release in the `gx` folder
+and MERLOT specific extensions of these shapes in the `merlot` folder.
+Each of the folders contain the Participant and Service Offering shapes respectively. Ressources are currently not considered in MERLOT.
+
+## Ontology
+
+The ontology files contain the description of how a particular type is related to other types (e.g. that a MERLOT Legal Participant is a subclass of a Gaia-X Legal Participant).
+
+The `ontology` folder is analogously separated into Gaia-X and MERLOT specific ontologies.
+Both Gaia-X and MERLOT specific types are related back to the base classes that the XFSC catalog expects (gax-core:Participant and gax-core:ServiceOffering).
+
+## Merge script
+
+This folder also contains a `merge_shapes.py` script which is used by the build pipeline to combine all available shapes in the `shapes` folder into a single large `mergedShapes.ttl` file. This is done as the XFSC catalog expects such a single common shape file instead of individual files per type.

gxfs-catalog/README.md

@@ -1,2 +1,18 @@
-# gxfs-catalog
-Build repository for gxfs-catalog ([fc-service-server](https://gitlab.com/gaia-x/data-infrastructure-federation-services/cat/fc-service/-/tree/main/fc-service-server))
+# XFSC Federated Catalogue
+This folder contains the build files for the MERLOT-adapted XFSC Federated Catalogue as well as the patches that are used for the MERLOT specific changes.
+
+## Patches
+
+### truncate_schemas.patch
+In the original catalog the shapes and ontologies of the catalog would only be initialized if the database was not initialized yet. Since we want our build pipeline to always use the latest shapes from the `catalog-shapes` folder, this patch will truncate existing schemas in the database and always replace them with the shapes and ontologies from this repository.
+
+### optional_registry.patch
+This patch allows to disable the trust anchor registry check in the catalog that gets performed by the catalog after verifying the signature. It can be enabled by setting the `FEDERATEDCATALOGUE_VERIFICATION_TRUSTANCHORURL` parameter to an empty string. Furthermore the `FEDERATEDCATALOGUE_IGNORESSL` can be set to true to also disable checking for proper SSL certificates when resolving a given did:web.
+
+Both of these parameters are necessary for local development where the did:webs neither have a valid SSL certificate nor are they in any trust anchor registry.
+
+### ignore-compliance-signature.patch
+This patch disables the signature (verificationMethod) validation for credentials of type `gx:compliance` and `gx:legalRegistrationNumber`. This is neccessary if the Tagus release of the clearing house is used as it uses a custom implementation of the JsonWebSignature2020 standard which is incompatible with the "proper" implementation that is used for validation in the catalog.
+
+### ignore-compliance-claims.patch
+This patch blocks the import of claims from credentials of type `gx:compliance` into the graph database. This is necessary as the catalog claims graph is based on IDs and claims from the Credential Subject (CS) of each credential, whereas the compliance credentials are referencing IDs of the Verifiable Credential (VC) which is one layer above. This creates a discrepancy which would let the catalog fail to import a given self-description.

sd-creation-wizard-api/README.md

@@ -1 +1,3 @@
-# sd-creation-wizard-api
+# Self-Description Creation Wizard API
+
+This folder contains the build files for the XFSC Self-Description Creation Wizard API. The wizard API is used as-is except for the the schemas which are imported from the `catalog-shapes` folder of this repository.