Merge pull request #26 from OpenDataManchester/mermaid-diagrams

DsposalTom · web-flow · commit ff117bfc41d7 · 2023-01-27T15:54:32.000Z
Add ERD to all specs. Remove png diagrams
diff --git a/docs/1_Start_Here/1_4_Data_Schema.md b/docs/1_Start_Here/1_4_Data_Schema.md
@@ -4,21 +4,20 @@ description: The current data schema of the Open 3P open data standard for the p
 ---
 
 # Data Schema
-
-<!-- ``` mermaid
+``` mermaid
 erDiagram
   MATERIALS_CATALOGUE }o--o{ MATERIAL : within
   MATERIAL }o--o{ COMPONENT_CATALOGUE : within
   COMPONENT_CATALOGUE }o--o{ COMPLETE_PACKAGING : within
   COMPLETE_PACKAGING }o..o{ MULTIPACK : within
   COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
-  MULTIPACK }o..o{ LOAD_CATALOGUE : within
   COMPLETE_PACKAGING }o--o{ LOAD_CATALOGUE : within
+  MULTIPACK }o..o{ LOAD_CATALOGUE : within
   COMPONENT_CATALOGUE }o--o{ LOAD_CATALOGUE : within
   LOAD_CATALOGUE }o--o{ LOAD : within
-``` -->
+```
 
-<figure markdown>
+<!-- <figure markdown>
 [![Schema](../img/schema-v1.1-2022-12-20.jpg)](https://opendatamanchester.github.io/PPP/img/schema-v1.1-2022-12-20.jpg){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
diff --git a/docs/3_Data_Specification/3_1_Material_Catalogue.md b/docs/3_Data_Specification/3_1_Material_Catalogue.md
@@ -21,11 +21,8 @@ The materials catalogue schema contains information regarding the base material.
 
 ## Diagram
 
-<!-- ``` mermaid
+``` mermaid
 erDiagram
-  MATERIAL_TYPE }o..o{ MATERIALS_CATALOGUE : atritube
-  MATERIAL_PURPOSE }o..o{ MATERIALS_CATALOGUE : atritube
-  MATERIAL_CATEGORY }o--o{ MATERIALS_CATALOGUE : atritube
   MATERIALS_CATALOGUE {
     identifier String
     materialVolume numeric
@@ -37,13 +34,19 @@ erDiagram
     virginMaterial numeric
     updateDate String
   }
+  MATERIALS_CATALOGUE }o..o{ CONTOLLED_LISTS : attritubes
   MATERIALS_CATALOGUE }o--o{ MATERIALS : within
-``` -->
+      CONTOLLED_LISTS {
+    materialType recommended
+    materialPurpose recommended
+    materialCategory required
+  }
+```
 
-<figure markdown>
+<!-- <figure markdown>
 [![Schema](../img/material_catalogue-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/material_catalogue-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
 
 ## Template
 
diff --git a/docs/3_Data_Specification/3_2_Material.md b/docs/3_Data_Specification/3_2_Material.md
@@ -19,10 +19,29 @@ The materials schema contains information regarding the materials that are used
 
 ## Diagram
 
-<figure markdown>
+``` mermaid
+erDiagram
+MATERIALS_CATALOGUE }o--o{ MATERIALS : within
+  MATERIALS {
+    identifier String
+    materialIdentifier numeric
+    materialCatalogue String
+    layer String
+    materialWeight String
+    combinationPurpose String
+    updateDate String
+  }
+  MATERIALS }o..o{ CONTOLLED_LISTS : attritubes
+  MATERIALS }o--o{ COMPONENT_CATALOGUE : within
+        CONTOLLED_LISTS {
+    materialFunction recommended
+    }
+```
+
+<!-- <figure markdown>
 [![Schema](../img/materials-v1.0-2022-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/materials-v1.0-2022-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
 
 ## Template
 Materials should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one material for a component. An example is provided.
diff --git a/docs/3_Data_Specification/3_3_Component_Catalogue.md b/docs/3_Data_Specification/3_3_Component_Catalogue.md
@@ -52,12 +52,74 @@ The component catalogue schema contains information regarding the components tha
 
 ## Diagram
 
-<figure markdown>
+``` mermaid
+erDiagram
+MATERIALS }o--o{ COMPONENT_CATALOGUE : within
+  COMPONENT_CATALOGUE {
+    identifier String
+    name numeric
+    description String
+    tags Dictionary
+    imageURL URL
+    LOWcode String
+    height Numeric
+    heightDate String
+    width Numeric
+    widthDate String
+    depth Numeric
+    depthDate String
+    volume Numeric
+    volumeDate String
+    weight Numeric
+    weightTolerance Numeric
+    weightDate String
+    shape String
+    function String
+    flexibility String
+    branding Boolean
+    componentRecyclingDisruptors String
+    colour String
+    opacity String
+    loaned Boolean
+    reuseSystem String
+    manufacturedCountry Numeric
+    recycledContent Numeric
+    recycledContentEvidenceType String
+    recycledContentEvidenceReference String
+    recyclability Boolean
+    recyclabilitySource String
+    recyclabilityDate String
+    partOfMultipack Boolean
+    previouslyAssembledComponent Boolean
+    componentLink String
+    updateDate String
+    releaseDate String
+    discontinueDate String
+  }
+  COMPONENT_CATALOGUE }o..o{ CONTOLLED_LISTS : attritubes
+  COMPONENT_CATALOGUE }o--o{ COMPLETE_PACKAGING : within
+  COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
+  MULTIPACK }o..o{ LOAD_CATALOGUE : within
+  COMPLETE_PACKAGING }o..o{ MULTIPACK : within
+  COMPLETE_PACKAGING }o..o{ LOAD_CATALOGUE : within
+  COMPONENT_CATALOGUE }o..o{ LOAD_CATALOGUE : within
+    CONTOLLED_LISTS {
+    recyclabilitySource recommended
+    shape recommended
+    function recommended
+    flexibility recommended
+    componentRecyclingDisruptors recommended
+    opacity recommended
+    recycledContentEvidenceType required
+  }
+```
+
+<!-- <figure markdown>
 [![Schema](../img/component-catalogue-v1.0.0-22-12-20.png){ width="800" }](https://opendatamanchester.github.io/PPP/img/component-catalogue-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
 </figure>
 
-## Template
+## Template -->
 
 Components should be provided as a separate csv file, in tidy format. This means that each row of the csv file should be one component of a complete package. An example is provided.
 
diff --git a/docs/3_Data_Specification/3_4_Complete_Packaging.md b/docs/3_Data_Specification/3_4_Complete_Packaging.md
@@ -46,8 +46,61 @@ The complete packaging schema contains information regarding the complete packag
 
 ## Diagram
 
+``` mermaid
+erDiagram
+COMPONENT_CATALOGUE }o--o{ COMPLETE_PACKAGING : within
+  COMPLETE_PACKAGING {
+    identifier String
+    name String
+    description String
+    tags Dictionary
+    imageURL URL
+    componentItems String
+    LOWcodeWOproduct String
+    productType String
+    componentContactWithProduct String
+    LOWcodeWproduct String
+    onTheGo Boolean
+    householdWaste Boolean
+    depositReturnScheme String
+    recyclingDisruptors String
+    recyclability Boolean
+    recyclabilitySource String
+    recyclabilityDate String
+    height Numeric
+    heightDate String
+    width Numeric
+    widthDate String
+    depth Numeric
+    depthDate String
+    volume Numeric
+    volumeDate String
+    weight Numeric
+    weightTolerance Numeric
+    weightDate String
+    servingCapacity Numeric
+    servingCapacityDate String
+    partOfMultipack Boolean
+    updateDate String
+    releaseDate String
+    discontinueDate String
+  }
+  COMPLETE_PACKAGING }o..o{ CONTOLLED_LISTS : attritubes
+  COMPLETE_PACKAGING }o..o{ MULTIPACK : within
+  COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
+  COMPLETE_PACKAGING }o..o{ LOAD_CATALOGUE : within
+  MULTIPACK }o..o{ LOAD_CATALOGUE : within
+  COMPONENT_CATALOGUE }o..o{ LOAD_CATALOGUE : within
+      CONTOLLED_LISTS {
+    productType recommended
+    depositReturnScheme recommended
+    recyclingDisruptors recommended
+    recyclabilitySource recommended
+  }
+```
+
 <figure markdown>
-[![Schema](../img/complete-packaging-v1.0.0-22-12-20.png){ width="800" }](https://opendatamanchester.github.io/PPP/img/complete-packaging-v1.0.0-22-12-20.png)){target=_blank}
+[![Schema](../img/complete-packaging-v1.0.0-22-12-20.png){ width="800" }](https://opendatamanchester.github.io/PPP/img/complete-packaging-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
 </figure>
 
diff --git a/docs/3_Data_Specification/3_5_Multipack.md b/docs/3_Data_Specification/3_5_Multipack.md
@@ -25,9 +25,11 @@ The multipack schema contains information regarding the multipacks that are used
 
 ## Diagram
 
-<!-- ``` mermaid
+``` mermaid
 erDiagram
-  LOAD_CATATLOGUE }o..o{ MULTIPACK : part
+COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
+COMPONENT_CATALOGUE }o..o{ COMPLETE_PACKAGING : within
+COMPLETE_PACKAGING }o..o{ MULTIPACK : within
   MULTIPACK {
     identifier String
     name String
@@ -41,14 +43,15 @@ erDiagram
     releaseDate String
     discontinueDate String
   }
-  MULTIPACK }o--o{ COMPLETE_PACKAGING : contains
-  MULTIPACK }o--o{ COMPONENT_CATATLOGUE : contains
-``` -->
+  COMPLETE_PACKAGING }o..o{ LOAD_CATALOGUE : within
+  MULTIPACK }o..o{ LOAD_CATALOGUE : within
+  COMPONENT_CATALOGUE }o--o{ LOAD_CATALOGUE : within
+```
 
-<figure markdown>
+<!-- <figure markdown>
 [![Schema](../img/multipack-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/multipack-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
 
 ## Template
 
diff --git a/docs/3_Data_Specification/3_6_Load_Catalogue.md b/docs/3_Data_Specification/3_6_Load_Catalogue.md
@@ -21,10 +21,35 @@ All the complete packaging from different levels (primary, secondary, and tertia
 
 ## Diagram
 
-<figure markdown>
+``` mermaid
+erDiagram
+COMPONENT_CATALOGUE }o..o{ LOAD_CATALOGUE : within
+COMPONENT_CATALOGUE }o..o{ COMPLETE_PACKAGING : within
+COMPONENT_CATALOGUE }o..o{ MULTIPACK : within
+MULTIPACK }o..o{ LOAD_CATALOGUE : within
+COMPLETE_PACKAGING }o..o{ LOAD_CATALOGUE : within
+COMPLETE_PACKAGING }o..o{ MULTIPACK : within
+
+  LOAD_CATALOGUE {
+    identifier String
+    materialIdentifier numeric
+    materialCatalogue String
+    layer String
+    materialWeight String
+    combinationPurpose String
+    updateDate String
+  }
+  LOAD_CATALOGUE }o..o{ CONTOLLED_LISTS : attritubes
+  LOAD_CATALOGUE }o--o{ LOAD : within
+        CONTOLLED_LISTS {
+    level required
+    }
+```
+
+<!-- <figure markdown>
 [![Schema](../img/load-catalogue-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/load-catalogue-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
 
 ## Template
 
diff --git a/docs/3_Data_Specification/3_7_Load.md b/docs/3_Data_Specification/3_7_Load.md
@@ -25,10 +25,29 @@ All the complete packaging from different levels (primary, secondary, and tertia
 
 ## Diagram
 
-<figure markdown>
+``` mermaid
+erDiagram
+LOAD_CATALOGUE }o..o{ LOAD : within
+  LOAD {
+    identifier String
+    name numeric
+    description String
+    tags Dictionary
+    loadIdentifier String
+    startDate String
+    destinationAddressName String
+    destinationAddressStreet String
+    destinationAddressCountry String
+    destinationPostalCode String
+    timesSent Numeric
+    updateDate String
+  }
+```
+
+<!-- <figure markdown>
 [![Schema](../img/load-v1.0.0-22-12-20.png){ width="450" }](https://opendatamanchester.github.io/PPP/img/load-v1.0.0-22-12-20.png){target=_blank}
   <figcaption>Data schema</figcaption>
-</figure>
+</figure> -->
 
 ## Template
 
