-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MINOR: Initial proposal for the 'developing a connector' user guide #15335
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pmbrull
reviewed
Feb 23, 2024
|
||
## Steps | ||
|
||
1. [Define the JSON Schema](/developers/contribute/developing-a-new-connector/define-json-schema) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we have cooler components to prompt users to clicking
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can use something like this
{% tilesContainer %}
{% tile
title="Run Connectors from the OpenMetadata UI"
description="Learn how to manage your deployment to run connectors from the UI"
link="/deployment/ingestion/openmetadata"
/ %}
{% tile
title="External Schedulers"
description="Get more information about running the Ingestion Framework Externally"
link="/deployment/ingestion/external"
/ %}
{% /tilesContainer %}
pmbrull
reviewed
Feb 23, 2024
...a-docs/content/v1.3.x/developers/contribute/developing-a-new-connector/define-json-schema.md
Show resolved
Hide resolved
pmbrull
approved these changes
Feb 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
Ingestion
safe to test
Add this label to run secure Github workflows on PRs
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes:
Like the title says, Initial proposar for the documentation on How to develop a connector.
Whenever possible I try to make use of the Code Preview to help the reader follow along with examples.
It is structured with different sections, as follows
Overview
Small overview on what it means to develop a New Connector and when it makes sense vs a Custom Connector
Prerequisite
Points to seting up the Developing environment for OpenMetadata
Steps
1. Define the JSOn Schema
2. Develop the Ingestion Code
3. Apply UI Changes
4. Create the Java ClassConverter
5. Update the Documentation
6. Test it
make coverage
References
Links to related Webinars
Type of change:
Checklist:
Fixes <issue-number>: <short explanation>