- 
+
@@ -31,7 +31,7 @@ Play with our [demo app](https://demo.oddp.io)!
## Introduction
-ODD is an open-source data discovery and observability tool for data teams that helps to efficiently democratise data, power collaboration and reduce time on data discovery through modern user-friendly environment.
+ODD is an open-source data discovery and observability tool for data teams that helps to efficiently democratise data, power collaboration and reduce time on data discovery through modern user-friendly environment.
### Key wins
@@ -41,9 +41,7 @@ ODD is an open-source data discovery and observability tool for data teams that
* Accelerate data insights
* Know the sources of your dashboards and ad hoc reports
* Deprecate outdated objects responsibly by assessing and mitigating the risks
-
-
-* :point_right: ODD Platform is a reference implementation of **[Open Data Discovery Spec](https://github.com/opendatadiscovery/opendatadiscovery-specification)**.
+* :point_right: ODD Platform is a reference implementation of **[Open Data Discovery Spec](https://github.com/opendatadiscovery/opendatadiscovery-specification)**
## Features
@@ -53,14 +51,12 @@ ODD is an open-source data discovery and observability tool for data teams that
* Gain observability through E2E Data objects Lineage
* Benefit from cutting-edge E2E microservices Lineage feature in tracking your data flow through the whole data landscape
* Be warned and alerted by Pipeline Monitoring tools
-* Store your metadata
+* Store your metadata
* Use ODD-native modern lightweight UI
-
### ML First citizen
-* Save results of your ML Experiments by automatically logging its parameters
-
+* Save results of your ML Experiments by automatically logging its parameters
### Data Security & Compliance
@@ -68,11 +64,10 @@ ODD is an open-source data discovery and observability tool for data teams that
* Refer to Tags to stay compliant with data security standards
* Have full transparency on how and by whom the data is used
-
-### Data Quality
+### Data Quality
* Utilize advanced Data Quality Dashboard to gain insights into data quality metrics, trends, and issues across your datasets, enabling proactive data quality management
-* Simplify DQ processes by using ODD with Great Expectations and DBT tests compatibility
+* Simplify DQ processes by using ODD with Great Expectations and DBT tests compatibility
* Integrate ODD with any custom DQ framework
### Reference Data Management (Lookup Tables) - a part of Master Data Management (MDM)
@@ -81,37 +76,41 @@ ODD is an open-source data discovery and observability tool for data teams that
* Easily integrate Lookup Tables with data pipelines and transformations, enhancing data enrichment and validation processes
* Support data governance and compliance efforts by maintaining accurate and consistent reference data across all data assets
+## Getting Started
-## Getting Started
### Running as a separate container
Setting up PostgreSQL connection details, for example:
-```
-export POSTGRES_HOST=172.17.0.1 \
-export POSTGRES_PORT=5432 \
-export POSTGRES_DATABASE=postgres \
-export POSTGRES_USER=postgres \
+
+```shell
+export POSTGRES_HOST=172.17.0.1
+export POSTGRES_PORT=5432
+export POSTGRES_DATABASE=postgres
+export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=mysecretpassword
```
+
Starting new instance of the platform:
-```
+
+```shell
docker run -d \
--name odd-platform \
-e SPRING_DATASOURCE_URL=jdbc:postgresql://${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DATABASE} \
-e SPRING_DATASOURCE_USERNAME=${POSTGRES_USER} \
- -e SPRING_DATASOURCE_PASSWORD=${POSTGRES_PASSWORD} \
+ -e SPRING_DATASOURCE_PASSWORD=${POSTGRES_PASSWORD} \
-p 8080:8080 \
ghcr.io/opendatadiscovery/odd-platform:latest
```
-Go to [localhost:8080](http://localhost:8080) in case of local environment
+
+Go to [localhost:8080](http://localhost:8080) in case of local environment.
### Running Locally with Docker Compose
-```
+```shell
docker-compose -f docker/demo.yaml up -d odd-platform-enricher
```
-* :point_right: **[QUICKSTART](./docker/README.md)**
+* :point_right: **[QUICKSTART](./docker/README.md)**
### Deploying to Kubernetes with Helm Charts
@@ -123,19 +122,21 @@ There are various example configurations (via docker-compose) within **[docker/e
## Contributing
-Contributing to ODD Platform is very welcome. For basic contributions, all you need is being comfortable with GitHub and Git. The best ways to contribute are:
-* Work on new adapters
+Contributing to ODD Platform is very welcome. For basic contributions, all you need is being comfortable with GitHub and Git. The best ways to contribute are:
+
+* Work on new adapters
* Work on documentation
-To ensure equal and positive communication, we adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). Before starting any interactions with this repository, please read it and make sure to follow.
+To ensure equal and positive communication, we adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). Before starting any interactions with this repository, please read it and make sure to follow.
-Please before contributing check out our [Contributing Guide](./CONTRIBUTING.md) and issues labeled "good first issue":
+Please before contributing check out our [Contributing Guide](./CONTRIBUTING.md) and issues labeled "good first issue":
[](https://github.com/opendatadiscovery/odd-platform/contribute)
## Integrations
+
OpenDataDiscovery Platform offers comprehensive data source support to meet your needs.