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

[python-cdk] README cleanup #37306

Merged
merged 2 commits into from Apr 16, 2024
Merged

[python-cdk] README cleanup #37306

merged 2 commits into from Apr 16, 2024

Conversation

natikgadzhi
Copy link
Contributor

What

Cleaning up our contributor-facing documentation, one file at a time. This time, I stumbled at the cdk readme and tried to update it a bit.

@natikgadzhi natikgadzhi requested a review from a team as a code owner April 13, 2024 04:16
Copy link

vercel bot commented Apr 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2024 10:01pm

@octavia-squidington-iii octavia-squidington-iii added the CDK Connector Development Kit label Apr 13, 2024
Copy link
Contributor

@girarda girarda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📜

- [Stripe](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-stripe/source_stripe/source.py)
- [Slack](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-slack/source_slack/source.py)
- [Stripe](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-stripe/)
- [Salesforce](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-salesforce/)

**Simple Python connectors using the bare-bones `Source` abstraction**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Simple"

declarative manifest language to define streams, operations, etc. This makes it easier to build
connectors without writing Python code.
- `sources/file_based` is the CDK for file-based sources. Examples include S3, Azure, GCS, etc.
- `sources/singer` is a singer tap source adapter. Deprecated.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what needs to happen before we can delete these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question — I think we want to make sure no sources actually use singer? Let me check.

@natikgadzhi natikgadzhi merged commit e4c942e into master Apr 16, 2024
7 of 10 checks passed
@natikgadzhi natikgadzhi deleted the ng/docs/airbyte-cdk/readme branch April 16, 2024 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CDK Connector Development Kit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants