Skip to content
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
merged 2 commits into from
Feb 26, 2024

Conversation

IceS2
Copy link
Contributor

@IceS2 IceS2 commented Feb 23, 2024

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

  • Small overview on why JSON Schemas
  • Explains the Anatomy of a Connection File
  • Explains how to make the Connection available to the Service

2. Develop the Ingestion Code

  • Recommends a good Article explaining the Ingestion Framework
  • Explains Service Topology
  • Explains Service Source

3. Apply UI Changes

  • Explains what to change to be able to configure the Connector through the UI
  • Explains how to create the "follow-along" documentation

4. Create the Java ClassConverter

  • Explains when a ClassConverter is needed and roughly why
  • Explains how to implement a ClassConverter
  • Explains how to add the ClassConverter to the ClassConverterFactory

5. Update the Documentation

  • Explains where the documentation is, what is the standard and what files should be created/updated
  • Explains how to test the documentation changes locally

6. Test it

  • Explains how to run Unit Tests, make coverage
  • Explains how to run the Connector from the CLI
  • Explains how to run the Connector from the UI

References

Links to related Webinars


Type of change:

  • Bug fix
  • Improvement
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.


## Steps

1. [Define the JSON Schema](/developers/contribute/developing-a-new-connector/define-json-schema)
Copy link
Collaborator

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

Copy link
Collaborator

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 pmbrull merged commit 22d0b08 into open-metadata:main Feb 26, 2024
18 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants