Skip to content

Commit

Permalink
doc(fivetran_sdk): README changes (#92)
Browse files Browse the repository at this point in the history
* documentation change

* update link

---------

Co-authored-by: Satvik Patil <[email protected]>
  • Loading branch information
fivetran-satvikpatil and Satvik Patil authored Feb 6, 2025
1 parent e886444 commit 466a61b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ A way for partners to create source and destination connectors that run on [Five

## Repo Structure
This repo consists of example source and destination connectors along with a local testing environment. Both connectors are written in a [gRPC supported language](https://grpc.io/docs/languages/) that can generate a statically linked binary. We recommend Java, Golang, or Rust.
* [V2 Examples](examples)
* [Examples](examples)
* [Local Testing Tools](tools/)

## Development
You can follow the [SDK Development Guide](development-guide.md) for guidance on how to develop your code.

> NOTE: If you're a new partner that just started working with the Connector SDK, use V2 release. We will continue to support V1 release for partners that have used them to build their SDK connectors, and these will be removed once the migration to V2 is complete.
> NOTE: If you're a new partner that just started working with the Connector SDK, use [V2 release](https://github.com/fivetran/fivetran_sdk/releases/tag/v2). We will continue to support [V1 release](https://github.com/fivetran/fivetran_sdk/releases/tag/v1) for partners that have used them to build their SDK connectors, and these will be removed once the migration to V2 is complete.
Once you have your code ready to run:
1. Start up your connector running on port 50051 (for destination code, use port 50052).
Expand Down
4 changes: 1 addition & 3 deletions development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ The executable needs to do the following:

* Partners should not add the proto files to their repos. Proto files should be pulled in from this repo at build time and added to `.gitignore` so they are excluded.
* Always use proto files from latest release and update you're code if necessary. Older releases proto files can be considered deprecated and will be expired at later date.
* New partners that just started working with the Connector SDK should use V2 release. We will continue to support V1 release for partners that have used them to build their SDK connectors, and these will be removed once the migration to V2 is complete.


### Logging

Expand Down Expand Up @@ -59,7 +57,7 @@ The executable needs to do the following:
- Partners can throw alerts on the Fivetran dashboard to notify customers about potential issues with their connector.
- These issues may include bad source data or connection problems with the source itself. Where applicable, the alerts should also provide guidance to customers on how to resolve the problem.
- We allow throwing [errors](https://fivetran.com/docs/using-fivetran/fivetran-dashboard/alerts#errors) and [warnings](https://fivetran.com/docs/using-fivetran/fivetran-dashboard/alerts#warnings).
- Partner code should use [Warning](https://github.com/fivetran/fivetran_sdk/blob/main/v2/common_v2.proto#L160) and [Task](https://github.com/fivetran/fivetran_sdk/blob/main/v2/common_v2.proto#L164) messages defined in the proto files to relay information or errors to Fivetran.
- Partner code should use [Warning](https://github.com/fivetran/fivetran_sdk/blob/main/common.proto#L160) and [Task](https://github.com/fivetran/fivetran_sdk/blob/main/common.proto#L164) messages defined in the proto files to relay information or errors to Fivetran.
- Usage example:
```
responseObserver.onNext(
Expand Down

0 comments on commit 466a61b

Please sign in to comment.