Skip to content

Commit

Permalink
GitBook: [#1] Plugin standards documentation (#2011)
Browse files Browse the repository at this point in the history
* GitBook: [#1] Plugin standards documentation

Signed-off-by: Felix Wang <wangfelix98@gmail.com>

* Modify Kafka documentation

Signed-off-by: Felix Wang <wangfelix98@gmail.com>
  • Loading branch information
felixwang9817 authored Nov 11, 2021
1 parent 9b430ca commit c50b398
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/getting-started/third-party-integrations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Third party integrations

We integrate with a wide set of tools and technologies so you can make Feast work in your existing stack. Many of these integrations are maintained as plugins to the main Feast repo.&#x20;
We integrate with a wide set of tools and technologies so you can make Feast work in your existing stack. Many of these integrations are maintained as plugins to the main Feast repo.

{% hint style="info" %}
Don't see your offline store or online store of choice here? Check our our guides to make a custom one!
Expand All @@ -19,7 +19,7 @@ Don't see your offline store or online store of choice here? Check our our guide
* [x] [Synapse source (community plugin)](https://github.com/Azure/feast-azure)
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
* [x] [Postgres (community plugin)](https://github.com/nossrannug/feast-postgres)
* [ ] Kafka source (Planned for Q4 2021)
* [x] Kafka source (with [push support into the online store](https://docs.feast.dev/reference/alpha-stream-ingestion))
* [ ] Snowflake source (Planned for Q4 2021)
* [ ] HTTP source

Expand Down Expand Up @@ -56,3 +56,17 @@ Don't see your offline store or online store of choice here? Check our our guide



## Standards

In order for a plugin integration to be highlighted on this page, it must meet the following requirements:

1. The plugin must have tests. Ideally it would use the Feast universal tests (see this [guide](broken-reference) for an example), but custom tests are fine.
2. The plugin must have some basic documentation on how it should be used.
3. The author must work with a maintainer to pass a basic code review (e.g. to ensure that the implementation roughly matches the core Feast implementations).&#x20;

In order for a plugin integration to be merged into the main Feast repo, it must meet the following requirements:

1. The PR must pass all integration tests. The universal tests (tests specifically designed for custom integrations) must be updated to test the integration.
2. There is documentation and a tutorial on how to use the integration.
3. The author (or someone else) agrees to take ownership of all the files, and maintain those files going forward.
4. If the plugin is being contributed by an organization, and not an individual, the organization should provide the infrastructure (or credits) for integration tests.

0 comments on commit c50b398

Please sign in to comment.