Skip to content

Commit ce14cba

Browse files
PeteZ238johnhrochpflookyjochenchrist
authored
docs(TIDY UP): Update broken test docs and general cleanup (#152)
* doc: added tags into fundamentals def * Fix exlcusiveMaximum and exclusiveMinimum to be number type instead of boolean, create script to show diff between JSON schema version for pull request * Update validate examples script to 3.1.0, update all data types examples to show exclusiveMinimum and exclusiveMaximum usage, remove strict schema testing example * Push to temp file for schema diff output * Add in pull request write permissions * Add in github token for action * Try remove permissions from YAML * Remove other calls to github rest api * Use custom token secret to push comment * Update changelog with v3.1.0 changes, remove github action for schema diff, update README with exclusiveMaximum and exclusiveMinimum changes * Print out command in stout and push schema diff to file * Update server sources to use examples rather than restrict with enums * Add in RFC-0017 date types * feat: add automatic light/dark mode toggle to mkdocs configuration * docs(TIDY UP): Update broken test docs and general cleanup * chore(PRE-COMMIT): Updated the version of pre-commit hooks * docs(CONTRIBUTING): Updated CONTRIBUTING.md for local dev env * chore(LINT CONFIG): Re-order markdown lint config Signed-off-by: Pete Zoumpoulis <petezouboulis238@gmail.com> * docs(README): Fix linting issues * chore(DOCS): Remove pre-commit hooks and markdown linting config --------- Signed-off-by: Pete Zoumpoulis <petezouboulis238@gmail.com> Co-authored-by: johnroch <78982434+johnhroch@users.noreply.github.com> Co-authored-by: Peter Flook <pflooky@hotmail.com> Co-authored-by: jochen <jochen.christ@innoq.com>
1 parent 2b9281a commit ce14cba

File tree

8 files changed

+169
-143
lines changed

8 files changed

+169
-143
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
site
55
*.iml
66
.cache
7+
*.venv
78

89
docs/changelog.md
910
docs/contributing.md
1011
docs/home.md
1112
docs/vendors.md
12-
docs/examples/**/*.md
13+
docs/examples/**/*.md

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color
77
# Contributing to Open Data Contract Standard
88

99
Thank you for your interest in contributing to Open Data Contract Standard (ODCS). Please refer to the [TSC contributing guidelines](https://github.com/bitol-io/tsc/blob/main/CONTRIBUTING.md).
10-

building-doc.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Automatic documentation builder
2+
23
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.
34

45
## Mkdocs mike versioning
6+
57
To start with using [mike](https://github.com/jimporter/mike) as a tool for versioning the documentation, the following was run:
68

79
```bash
@@ -12,13 +14,16 @@ mike set-default --push latest #by default, users will go to
1214
```
1315

1416
## Deploying a new version
15-
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
17+
18+
Given that the [Github action](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
1619
created, all that is required is to:
20+
1721
1. [Create a new release](https://github.com/bitol-io/open-data-contract-standard/releases)
1822
2. Put in new tag version for release (follows pattern v*)
1923
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
2024

2125
## Delete version
26+
2227
If a version tag was pushed that was incorrect, it can be deleted via:
2328

2429
```bash

docs/README.md

Lines changed: 154 additions & 132 deletions
Large diffs are not rendered by default.

docs/examples/schema/kafka-schemaregistry.odcs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ servers:
1717
- server: my-kafka
1818
type: kafka
1919
format: avro
20-
host: kafkabroker1:9092
20+
host: kafkabroker1:9092

resources.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,19 @@
2424
* 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)
2525
* 2023-05-01 - [PayPal open sources its data contract template](https://jgp.ai/2023/05/01/paypal-open-sources-its-data-contract-template/)
2626

27-
If you spot an article about the Open Data Contract Standard, make a pull request!
27+
If you spot an article about the Open Data Contract Standard, make a pull request!
2828

2929
## Books
3030

3131
* 2024-09-01 - **Implementing Data Mesh**, [O'Reilly](https://www.oreilly.com/library/view/implementing-data-mesh/9781098156213/), [Amazon](https://amzn.to/3ysN3Jf): in Chapter 5, ODCS is extensively used & described.
3232
* 2024-01-20 - **Data Contracts for all ages**, [Amazon](https://amzn.to/3Wl1My1).
3333

34-
If you spot a book about the Open Data Contract Standard, make a pull request!
34+
If you spot a book about the Open Data Contract Standard, make a pull request!
3535

3636
## Videos
3737

3838
* 2025-03-28 - [What is a Data Contract? - DataFriday 5x01](https://www.youtube.com/watch?v=Iq6SxdsIHHE)
3939
* 2024-01-02 - [What is a Data Contract? from IBM Technology](https://www.youtube.com/watch?v=-n3OD-ml_k0)
40-
*
41-
If you spot a video about the Open Data Contract Standard, make a pull request!
40+
*
41+
42+
If you spot a video about the Open Data Contract Standard, make a pull request!

schema/odcs-json-schema-v3.1.0.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,6 @@
358358
"$ref": "#/$defs/ServerSource/InformixServer"
359359
}
360360
},
361-
362361
{
363362
"if": {
364363
"properties": {

vendors.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ catalogs, data quality platforms, security tools, and more.
1111
* [Data Contract CLI](https://cli.datacontract.com) - Open Source tooling around data contracts
1212
* [Data Contract Manager](https://datacontract-manager.com) - Professional data contract management tool with Data Marketplace, Access Management, and Data Governance AI.
1313
* [Data Contract Playground](https://data-catering.github.io/data-contract-playground/) - Playground site for creating, exporting and validating data contracts
14-
* [DQC.ai | DQ PLATFORM](https://www.dqc.ai/dqc-platform) - [Enhancing Data Quality with ODCS: A Standard Ensured by the DQ Platform
15-
](https://www.dqc.ai/post/enhancing-data-quality-with-odcs-a-standard-ensured-by-the-dq-platform)
14+
* [DQC.ai | DQ PLATFORM](https://www.dqc.ai/dqc-platform) - [Enhancing Data Quality with ODCS: A Standard Ensured by the DQ Platform](https://www.dqc.ai/post/enhancing-data-quality-with-odcs-a-standard-ensured-by-the-dq-platform)
1615
* [Meta Analysis](https://www.meta-analysis.fr/en/home/) - Governance repository & Data Catalog, supports ODCS via a [flexible metamodel and open API](https://www.meta-analysis.fr/en/article-en/open-data-contract-standard-adoption/)
1716
* [Open Data Contract Standard (Python)](https://pypi.org/project/open-data-contract-standard/) - Python package to read and write YAML files using the Open Data Contract Standard
1817
* [Open Data Contract Standard (Excel Template)](https://github.com/datacontract/open-data-contract-standard-excel-template) - Excel Template for the Open Data Contract Standard

0 commit comments

Comments
 (0)