Merge pull request #15 from OpenDataManchester/tweaks-improvements-2023-01-12

DsposalTom · web-flow · commit 59200415fa86 · 2023-01-12T12:26:11.000Z
Tweaks improvements 2023 01 12
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,17 @@
+name: ci 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/docs/1_Start_Here/1_1_Introduction.md b/docs/1_Start_Here/1_1_Introduction.md
@@ -1,3 +1,8 @@
+---
+title: Introduction
+description: Introduction to the Open3P open data standard for the plastic value chain.
+---
+
 # Introduction
 
 ## What is the Open3P?
diff --git a/docs/1_Start_Here/1_2_Key_Concepts.md b/docs/1_Start_Here/1_2_Key_Concepts.md
@@ -1,3 +1,8 @@
+---
+title: Key Concepts
+description: The key concepts to understanding the open data standard for the plastic value chain.
+---
+
 # Key Concepts
 
 ## Material Catalogue
diff --git a/docs/1_Start_Here/1_3_Data_Flow.md b/docs/1_Start_Here/1_3_Data_Flow.md
@@ -1,3 +1,8 @@
+---
+title: Data Flow
+description: The intented flow of data through the plastic value chain using Open3P.
+---
+
 # Data Flow
 
 Here, we show two examples of how data could flow using the open standard. This tells the story of how water bottles are created with a packaging manufacturer, how that packaging manufacturer sends their packaging to a packer/filler (Figure 1), and then how that packer/filler will put packaging together, filled with a product and then send them to a retailer (Figure 2). In both figures: 
diff --git a/docs/1_Start_Here/1_4_Data_Schema.md b/docs/1_Start_Here/1_4_Data_Schema.md
@@ -1,4 +1,11 @@
-# Data Schema
+---
+title: Data Schema
+description: The current data schema of the Open3P open data standard for the plastic value chain.
+---
 
-<a href="/img/schema-v1.1-2022-12-20.jpg" target="_blank" title="Open schema in new tab">![Schema](../img/schema-v1.1-2022-12-20.jpg)</a>
+# Data Schema
 
+<figure markdown>
+![Schema](../img/schema-v1.1-2022-12-20.jpg)
+  <figcaption>Data schema</figcaption>
+</figure>
diff --git a/docs/2_Data_Formats/2_1_Data_Formats.md b/docs/2_Data_Formats/2_1_Data_Formats.md
@@ -1,3 +1,8 @@
+---
+title: Data Formats
+description: The data formats that should be used.
+---
+
 # Data Formats
 
 When publishing Plastic Packaging Portal data, the csv format should be used. csv files can be created and edited in text editors, as well as spreadsheet packages such as Microsoft Excel, Apple Numbers, or Open Office.
diff --git a/docs/3_Data_Specification/3_1_Material_Catalogue.md b/docs/3_Data_Specification/3_1_Material_Catalogue.md
@@ -1,3 +1,7 @@
+---
+title: Materials Catalogue
+---
+
 # Materials Catalogue
 
 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 that is combined in the materials csv to create combinations. An example is provided.
diff --git a/docs/3_Data_Specification/3_2_Material.md b/docs/3_Data_Specification/3_2_Material.md
@@ -1,8 +1,15 @@
+---
+title: Materials
+---
+
 # Materials
 
 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.
 
-<a href="/img/materials-v1.0-2022-12-20.png" target="_blank"><img src="/img/materials-v1.0-2022-12-20.png"target="_blank" title="Open schema in new tab" width="200px"></img></a>
+<figure markdown>
+![Schema](../img/materials-v1.0-2022-12-20.png){ width="450" }
+  <figcaption>Data schema</figcaption>
+</figure>
 
 The specification of this csv file is as follows:
 
diff --git a/docs/3_Data_Specification/3_3_Component_Catalogue.md b/docs/3_Data_Specification/3_3_Component_Catalogue.md
@@ -1,3 +1,7 @@
+---
+title: Component Catalogue
+---
+
 # Component Catalogue
 
 ## Standard Spreadsheet Format
diff --git a/docs/3_Data_Specification/3_4_Complete_Packaging.md b/docs/3_Data_Specification/3_4_Complete_Packaging.md
@@ -1,3 +1,7 @@
+---
+title: Complete Packaging
+---
+
 # Complete Packaging
 
 We can now use the unique components, to create a complete packaging. Each row refers to the complete package.
diff --git a/docs/3_Data_Specification/3_5_Multipack.md b/docs/3_Data_Specification/3_5_Multipack.md
@@ -1,3 +1,7 @@
+---
+title: Multipack
+---
+
 # Multipack
 
 If the complete packaging is further combined to create multipacks, the information is collected here. Each row corresponds to a single packaging item.
diff --git a/docs/3_Data_Specification/3_6_Load_Catalogue.md b/docs/3_Data_Specification/3_6_Load_Catalogue.md
@@ -1,3 +1,7 @@
+---
+title: Load Catalogue
+---
+
 # Load Catalogue
 
 All the complete packaging from different levels (primary, secondary, and tertiary), including multipacks, put together to send to the final destination. Each row corresponds to a single packaging item.
diff --git a/docs/3_Data_Specification/3_7_Load.md b/docs/3_Data_Specification/3_7_Load.md
@@ -1,3 +1,7 @@
+---
+title: Load
+---
+
 # Load
 
 All the complete packaging from different levels (primary, secondary, and tertiary), including multipacks, put together to send to the final destination. Each row corresponds a unique complete packaging (or multipack) item sent to a specific location during a specific time period.
diff --git a/docs/4_Identifiers/4_1_Identifiers.md b/docs/4_Identifiers/4_1_Identifiers.md
@@ -1,3 +1,7 @@
+---
+title: Identifiers
+---
+
 # Identifiers
 
 Identifiers are the way that humans and machines can know that a particular thing is definitely that thing. In the context of Open3P, there are different ways of talking about the various things involved. A packaging manufacturer may refer to a particular bottle as ‘small clear bottle’, but a filler may know it as ‘500 ml clear bottle’. In a database it may be recorded as ‘0.5L PET Bottle’. While these are all referring to the same thing, it could be hard for a human to know that they are the same, and pretty much impossible for a computer. 
diff --git a/docs/6_Governance/6_1_Governance.md b/docs/6_Governance/6_1_Governance.md
@@ -1,3 +1,7 @@
+---
+title: Governance
+---
+
 # Governance
 
 Description of the governance arrangements for the standard, To be agreed.
diff --git a/docs/8_Change_Log/8_1_Change_Log.md b/docs/8_Change_Log/8_1_Change_Log.md
@@ -1,3 +1,8 @@
+---
+title: Latest Updates
+---
+
+
 # Latest Updates
 A document that contains all the changes made to the standard.
 ## January 06, 2023
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,7 @@
+---
+title: The open data standard for the plastic packaging value chain.
+---
+
 [![Open Data Manchester](img/Open3PFullColour.jpg)](https://www.opendatamanchester.org.uk/plastics-packaging-portal/){target=_blank}
 
 ## Open3P: Definition
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,5 @@
 site_name: Open3P
+site_description: Open3P is an open data standard for the plastic value chain.
 theme:
   name: material
   favicon: img/favicon-192.png
@@ -49,6 +50,8 @@ markdown_extensions:
   - codehilite
   - smarty
   - meta
+  - attr_list
+  - md_in_html
   - toc:
       permalink: True
   - attr_list
