Add example project data

regen-network · Oct 3, 2024 · 1d1eac9 · 1d1eac9
1 parent 4f20f34
commit 1d1eac9
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 1 deletion.
diff --git a/schema/README.md b/schema/README.md
@@ -12,7 +12,7 @@
 - Create separate schema files for each logical schema class and `import` into the root `schemas.yaml` file.
 - Generated markdown from schemas:
     ```shell
-    gen-doc schema/src/schemas.yaml --directory schema/generated --diagram-type er_diagram
+    gen-doc schema/src/schemas.yaml --directory schema/generated --example-directory schema/examples --diagram-type er_diagram
     ```
 - Generate linkml enums for taxonomy terms:
     ```shell

diff --git a/schema/data/project-data.jsonld → schema/examples/Project-Terassos.jsonld b/schema/data/project-data.jsonld → schema/examples/Project-Terassos.jsonld
diff --git a/schema/data/project-data.yaml → schema/examples/Project-Terassos.yaml b/schema/data/project-data.yaml → schema/examples/Project-Terassos.yaml
diff --git a/schema/generated/Project.md b/schema/generated/Project.md
@@ -159,6 +159,73 @@ OffchainCreditsInfo ||--|o QuantityValue : "creditsRetired"
 
 
 
+## Examples
+### Example: Project-Terassos
+
+```yaml
+  id: "http://dev.app.regen.com/projects/38"
+  name: "Amazon Rainforest Conservation Project"
+  marketType: compliance
+  bioregion: "Amazon Basin"
+  biomeType: "TropicalForest"
+  watershed: "Amazon River"
+  subWatershed: "Upper Amazon"
+  environmentType:
+    - cloudForest
+  offchainCreditsInfo:
+    creditsRegistered:
+      numericValue: 1000
+      unit: unit:HA
+    creditsAvailable:
+      numericValue: 800
+      unit: unit:HA
+    creditsRetired:
+      numericValue: 200
+      unit: unit:HA
+  projectDuration: "P1Y"
+  creditClassVersion: "1.0"
+  ecologicalConnectivityIndex: 75.5
+  socialCulturalIndex: 85.0
+  environmentalAuthority:
+    name: "Corantioquia"
+    url: "http://corantioquia.gov.co/"
+  administrativeArea:
+    name: "Antioquia"
+  managementAreas:
+    - activity: 
+        - conservation
+      extent:
+        numericValue: 120
+        unit: unit:HA
+    - activity:
+        - ecosystemRestoration
+      extent:
+        numericValue: 220
+        unit: unit:HA
+  projectDeveloper:
+    name: Terrasos
+    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+    image: https://via.placeholder.com/150
+  projectOperator:
+    name: El Globo
+    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+    image: https://via.placeholder.com/150
+  projectVerifier:
+    name: KPMG
+    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+    image: https://via.placeholder.com/150
+  projectMonitor:
+    name: EAFIT
+    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+    image: https://via.placeholder.com/150
+  projectOwner:
+    name: Jose Gonzales
+    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
+    image: https://via.placeholder.com/150
+
+
+```
+