From 2df2e89c60e6f4390d1dbc9cf53725333ecd3383 Mon Sep 17 00:00:00 2001 From: Suresh Srinivas Date: Mon, 16 Aug 2021 15:51:04 -0700 Subject: [PATCH] Add ingestion docs to implement a connector --- docs/SUMMARY.md | 5 +++++ .../developer/build-a-connector/README.md | 8 +++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ba31f4bae4e..9e3499ba418 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -77,6 +77,11 @@ * [Coding Style](open-source-community/developer/coding-style.md) * [Build the code & run tests](open-source-community/developer/build-code-run-tests.md) * [Build a Connector](open-source-community/developer/build-a-connector/README.md) + * [Source](open-source-community/developer/build-a-connector/source.md) + * [Processor](open-source-community/developer/build-a-connector/processor.md) + * [Sink](open-source-community/developer/build-a-connector/sink.md) + * [Stage](open-source-community/developer/build-a-connector/stage.md) + * [BulkSink](open-source-community/developer/build-a-connector/bulksink.md) * [Run Integration Tests](open-source-community/developer/run-integration-tests.md) * [UX Style Guide](open-source-community/developer/ux-style-guide.md) diff --git a/docs/open-source-community/developer/build-a-connector/README.md b/docs/open-source-community/developer/build-a-connector/README.md index 31785cf95b9..65142668077 100644 --- a/docs/open-source-community/developer/build-a-connector/README.md +++ b/docs/open-source-community/developer/build-a-connector/README.md @@ -3,13 +3,11 @@ description: >- This design doc will walk through developing a connector for OpenMetadata --- -# Ingestion + +# Ingestion API Ingestion is a simple python framework to ingest the metadata from various sources. - -##API - Please look at our framework [APIs](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/api) @@ -17,7 +15,7 @@ Please look at our framework [APIs](https://github.com/open-metadata/OpenMetadat [workflow](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/workflow.py) is a simple orchestration job that runs the components in an Order. -It Consists of [Source](./source.md) , Optional [Processor](./processor.md), [Sink](./sink.md) . It also provides support for [Stage](./stage.md) , [BulkSink](./bulksink.md) +It consists of [Source](./source.md) ,[Processor](./processor.md), [Sink](./sink.md) . It also provides support for [Stage](./stage.md) , [BulkSink](./bulksink.md) Workflow execution happens in serial fashion.