Merge remote-tracking branch 'bitol/main' into dev

# Conflicts:
#	site/404.html
#	site/contributing/index.html
#	site/examples/all/full-example.yaml
#	site/examples/index.html
#	site/examples/quality/column-completeness.yaml
#	site/examples/quality/column-validity.yaml
#	site/index.html
#	site/search/search_index.json
#	site/sitemap.xml
#	site/sitemap.xml.gz
#	site/standard/index.html

Author: pflooky

.github/workflows/docs-site-deploy.yaml

@@ -1,8 +1,8 @@
 name: docs-site-deploy
 on:
   push:
-    tags:
-      - "v*"
+    branches:
+      - main
 permissions:
   contents: write
 jobs:
@@ -28,5 +28,8 @@ jobs:
             mkdocs-material-
       - run: pip install mkdocs-open-in-new-tab mike
       - run: pip install mkdocs-material
-      - run: mkdocs build
-      - run: mike deploy --push --update-aliases ${{ github.ref_name }} latest
+      - run: pip install "mkdocs-material[imaging]"
+      - run: bash script/build_docs.sh
+      - run: |
+          latest_tag=$(git describe --tags --abbrev=0)
+          mike deploy --push --update-aliases "$latest_tag" latest

.gitignore

@@ -1,3 +1,5 @@
 .idea
 .DS_Store
 .idea
+site
+*.iml

CHANGELOG.md

@@ -1,22 +1,30 @@
+---
+title: "Changelog: Open Data Contract Standard (ODCS)"
+description: "Home of Open Data Contract Standard (ODCS) documentation."
+image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color/Bitol_Logo_color.svg"
+---
+
 This document tracks the history and evolution of the **Open Data Contract Standard**.
 
-# v2.2.2 - 2024-01-05 - OPEN
+# v2.2.2 - 2024-05-23 - APPROVED
 
-* Change `dataset.description` data type from `array` to `string`
-* Change `dataset.column.isPrimaryKey` data type from `string` to `boolean`
-* Change `price.priceAmount` data type from `string` to `number`
-* Change `slaProperties.value` data type from `string` to `oneOf[string, number]`
-* Change `slaProperties.valueExt` data type from `string` to `oneOf[string, number]`
-* Update [examples](docs/examples) to adhere to JSON schema
-* Full example from README directs to [full-example.yaml](docs/examples/all/full-example.yaml)
-* Add in mkdocs for creating documentation website
+* In JSON schema validation:
+  * Change `dataset.description` data type from `array` to `string`.
+  * Change `dataset.column.isPrimaryKey` data type from `string` to `boolean`.
+  * Change `price.priceAmount` data type from `string` to `number`.
+  * Change `slaProperties.value` data type from `string` to `oneOf[string, number]`.
+  * Change `slaProperties.valueExt` data type from `string` to `oneOf[string, number]`.
+* Update [examples](docs/examples) to adhere to JSON schema.
+* Full example from README directs to [full-example.yaml](docs/examples/all/full-example.yaml).
+* Add in mkdocs for creating a [documentation website](https://bitol-io.github.io/open-data-contract-standard/). Check [building-doc.md](building-doc.md).
+* Add vendors page [vendors.md](vendors.md). Feel free to add anyone there.
 
 # v2.2.1 - 2023-12-18 - APPROVED
 
 * Reformat quality examples to be valid YAML.
 * Type of definition for authority have standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`.
 * Add in `isUnique`, `primaryKeyPosition`, `partitionKeyPosition`, and `clusterKeyPosition` to `column` definition.
-* Add [JSON schema](schema/odcs-json-schema.json) to validate YAML files for v2.2.1.
+* Add [JSON schema](https://github.com/bitol-io/open-data-contract-standard/blob/main/schema/odcs-json-schema.json) to validate YAML files for v2.2.1.
 * Integrated as part of [Bitol](https://lfaidata.foundation/projects/bitol/).
 * Reformat Markdown tables.
 

CONTRIBUTING.md

@@ -1,3 +1,9 @@
+---
+title: "Contributing: Open Data Contract Standard (ODCS)"
+description: "How you can contribute to the Open Data Contract Standard (ODCS)."
+image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color/Bitol_Logo_color.svg"
+---
+
 # Open Data Contract Standard
 
 ## Executive summary

README.md

@@ -1,3 +1,9 @@
+---
+title: "Open Data Contract Standard (ODCS)"
+description: "Home of Open Data Contract Standard (ODCS) documentation."
+image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color/Bitol_Logo_color.svg"
+---
+
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8149/badge)](https://www.bestpractices.dev/projects/8149)
 
 # Open Data Contract Standard (ODCS)
@@ -7,29 +13,32 @@ Welcome!
 Thanks for your interest and for taking the time to come here! ❤️
 
 ## Executive summary
-This standard describes a structure for a **data contract**. It's current version is v2.2.2. It is available for you as an Apache 2.0 license. Contributions are welcome!
+This standard describes a structure for a **data contract**. Its current version is v2.2.2. It is available for you as an Apache 2.0 license. Contributions are welcome!
 
 ## Discover the open standard
-Discover the [Open Data Contract Standard](docs/index.md). This file contains some explanations and several examples. More [examples](docs/examples/index.md) can be found here.
+A reader-friendly version of the standard can be found on its [dedicated site](https://bitol-io.github.io/open-data-contract-standard/).
+
+Discover the [Open Data Contract Standard](docs/standard.md). This file contains some explanations and several examples. More [examples](docs/examples/index.md) can be found here.
 
 ## What is a Data Contract?
 
 ### The basics of a data contract
 A data contract defines the agreement between a data producer and consumers. A data contract contains several sections:
-* Fundamentals.
-* Schema.
-* Data quality.
-* Service-level agreement (SLA).
-* Security & stakeholders.
-* Custom properties.
 
-![Data contract schema](./docs/img/data-contract-v2.2.1-schema.svg "Data contract schema")
+* [Fundamentals](docs/standard.md#demographics).
+* [Schema](docs/standard.md#dataset-and-schema).
+* [Data quality](docs/standard.md#data-quality).
+* [Service-level agreement (SLA)](docs/standard.md#service-level-agreement).
+* [Security & stakeholders](docs/standard.md#stakeholders).
+* [Custom properties](docs/standard.md#other-properties).
+
+![Data contract schema](docs/img/data-contract-v2.2.1-schema.svg "Data contract schema")
 
 *Figure 1: illustration of a data contract, its principal contributors, sections, and usage.*
 
 ### JSON Schema
 
-JSON Schema for ODCS can be found [here](schema/odcs-json-schema.json). You can import this schema into your IDE for 
+JSON Schema for ODCS can be found [here](https://github.com/bitol-io/open-data-contract-standard/blob/main/schema/odcs-json-schema.json). You can import this schema into your IDE for 
 validation of your YAML files. Links below show how you can import the schema:
 
 - [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom)
@@ -38,19 +47,23 @@ validation of your YAML files. Links below show how you can import the schema:
 ## Contributing to the project
 Check out the [CONTRIBUTING](./CONTRIBUTING.md) file.
 
-## Articles 
- * 2024-02-06 - [Getting started with ODCS](https://medium.com/abeadata/getting-started-with-odcs-3ba790707879)
- * 2023-12-08 - [Why the Need for Standardizing Data Contracts?](https://medium.com/abeadata/why-the-need-for-standardizing-data-contracts-133bc3491148)
- * 2023-11-30 - [Linux Foundation AI & Data - Bitol Joins LF AI & Data as New Sandbox Project](https://lfaidata.foundation/blog/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
- * 2023-11-30 - [AIDAUG - Bitol Joins LF AI & Data as New Sandbox Project](https://aidausergroup.org/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
- * 2023-10-01 - [Data Contracts: A Bridge Connecting Two Worlds](https://medium.com/@atanas.iliev.ai/data-contracts-a-bridge-connecting-two-worlds-404eff1d970d)
- * 2023-09-10 - [Data Contracts 101](https://medium.com/p/568a9adbf9a9)
- * 2023-08-10 - [Welcome to the Open Data Contract Standard](https://jgp.ai/2023/08/09/welcome-to-the-open-data-contract-standard/)
- * 2023-05-11 - [Data Contracts – Everything You Need to Know](https://www.montecarlodata.com/blog-data-contracts-explained/)
- * 2023-05-07 - [Data Engineering Weekly #130 - Data Contract in the Wild with PayPal’s Data Contract Template](https://www.dataengineeringweekly.com/p/data-engineering-weekly-130)
- * 2023-05-06 - [PayPal เปิด Data Contract เป็น Open Source Template ให้ไปใช้งานกัน](https://discuss.dataengineercafe.io/t/paypal-data-contract-open-source-template/581/1)
- * 2023-05-05 - [Jonathan Neo (j__neo ) on Reddit](https://www.reddit.com/r/dataengineering/comments/137glbo/comment/jixw5hj/?utm_source=reddit&utm_medium=web2x&context=3)
- * 2023-05-01 - [PayPal open sources its data contract template](https://jgp.ai/2023/05/01/paypal-open-sources-its-data-contract-template/)
+## Articles and Other Resources
+
+* 2024-05-30 - [ODCS Roadmap](https://medium.com/abeadata/odcs-roadmap-9b9a17367af4)
+* 2024-05-25 - [Conceptual model of Data Quality of Service as Code by Jarkko Moilanen](https://aidausergroup.org/2024/05/25/aida-user-group-forecaster-pi-day-highlights-data-quality-whats-new/)
+* 2024-02-06 - [Getting started with ODCS](https://medium.com/abeadata/getting-started-with-odcs-3ba790707879)
+* 2023-12-08 - [Why the Need for Standardizing Data Contracts?](https://medium.com/abeadata/why-the-need-for-standardizing-data-contracts-133bc3491148)
+* 2023-11-30 - [Linux Foundation AI & Data - Bitol Joins LF AI & Data as New Sandbox Project](https://lfaidata.foundation/blog/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
+* 2023-11-30 - [AIDAUG - Bitol Joins LF AI & Data as New Sandbox Project](https://aidausergroup.org/2023/11/30/bitol-joins-lf-ai-data-as-new-sandbox-project/)
+* 2023-11-22 - [What is, and what isn’t, a data contract](https://datacreation.substack.com/p/what-is-and-what-isnt-a-data-contract)
+* 2023-10-01 - [Data Contracts: A Bridge Connecting Two Worlds](https://medium.com/@atanas.iliev.ai/data-contracts-a-bridge-connecting-two-worlds-404eff1d970d)
+* 2023-09-10 - [Data Contracts 101](https://medium.com/p/568a9adbf9a9)
+* 2023-08-10 - [Welcome to the Open Data Contract Standard](https://jgp.ai/2023/08/09/welcome-to-the-open-data-contract-standard/)
+* 2023-05-11 - [Data Contracts – Everything You Need to Know](https://www.montecarlodata.com/blog-data-contracts-explained/)
+* 2023-05-07 - [Data Engineering Weekly #130 - Data Contract in the Wild with PayPal’s Data Contract Template](https://www.dataengineeringweekly.com/p/data-engineering-weekly-130)
+* 2023-05-06 - [PayPal เปิด Data Contract เป็น Open Source Template ให้ไปใช้งานกัน](https://discuss.dataengineercafe.io/t/paypal-data-contract-open-source-template/581/1)
+* 2023-05-05 - [Jonathan Neo (j__neo ) on Reddit](https://www.reddit.com/r/dataengineering/comments/137glbo/comment/jixw5hj/?utm_source=reddit&utm_medium=web2x&context=3)
+* 2023-05-01 - [PayPal open sources its data contract template](https://jgp.ai/2023/05/01/paypal-open-sources-its-data-contract-template/)
 
 If you spot an article about the Open Data Contract Standard, make a pull request! 
 
@@ -62,27 +75,4 @@ Formerly known as the data contract template, this standard is used to implement
 ### How does PayPal use Data Contracts?
 PayPal uses data contracts in many ways, but this [article](https://medium.com/paypal-tech/the-next-generation-of-data-platforms-is-the-data-mesh-b7df4b825522) from the [PayPal Technology blog](https://medium.com/paypal-tech) gives a good introduction.
 
-### Mkdocs mike versioning
-To start with using [mike](https://github.com/jimporter/mike) as a tool for versioning the documentation, the following was run:
-
-```bash
-pip install mike
-cd open-data-contract-standard                    #ensure you are inside the repo
-mike deploy --push --update-aliases v2.2.1 latest #set latest version to v2.2.1
-mike set-default --push latest                    #by default, users will go to latest
-```
-
-#### Deploying a new version
-Given that the Github action [here](.github/workflows/docs-site-deploy.yaml) it set to trigger when a new tag version is
-created, all that is required is to:
-1. [Create a new release](https://github.com/bitol-io/open-data-contract-standard/releases)
-2. Put in new tag version for release (follows pattern v*)
-3. Once release is created with new tag version, the Github action gets kicked off and mike will deploy the latest documentation linked to latest version tag
-
-#### Delete version
-If a version tag was pushed that was incorrect, it can be deleted via:
-
-```bash
-mike deploy --push --update-aliases <previous tag version> latest #set latest version to previous tag version
-mike delete <incorrect tag> --push
-```
+

building-doc.md

@@ -0,0 +1,27 @@
+# Automatic documentation builder
+Starting with ODCS v2.2.2, the documentation is available through [GitHub.io](https://bitol-io.github.io/open-data-contract-standard). This page explains the process of building the doc.
+
+## Mkdocs mike versioning
+To start with using [mike](https://github.com/jimporter/mike) as a tool for versioning the documentation, the following was run:
+
+```bash
+pip install mike
+cd open-data-contract-standard                    #ensure you are inside the repo
+mike deploy --push --update-aliases v2.2.1 latest #set latest version to v2.2.1
+mike set-default --push latest                    #by default, users will go to latest
+```
+
+## Deploying a new version
+Given that the Github action [here](https://github.com/bitol-io/open-data-contract-standard/blob/main/.github/workflows/docs-site-deploy.yaml) it set to trigger when a new tag version is
+created, all that is required is to:
+1. [Create a new release](https://github.com/bitol-io/open-data-contract-standard/releases)
+2. Put in new tag version for release (follows pattern v*)
+3. Once release is created with new tag version, the Github action gets kicked off and mike will deploy the latest documentation linked to latest version tag
+
+## Delete version
+If a version tag was pushed that was incorrect, it can be deleted via:
+
+```bash
+mike deploy --push --update-aliases <previous tag version> latest #set latest version to previous tag version
+mike delete <incorrect tag> --push
+```