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

fixes for processor template documentation #179

Merged
merged 2 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Conduit Processor Template"
sidebar_position: 1
---

## Initializing a Conduit Processor Project
Expand All @@ -27,17 +26,19 @@ Included in the Conduit Processor Template are:

:::note

By convention the name of the repository should be conduit-processor-[processor name]. So if you would like to reference the processor using foo, the repository should be named conduit-processor-foo.
By convention the name of the repository should be conduit-processor-`processor name`. So if you would like to reference the processor using foo, the repository should be named conduit-processor-foo.

:::


## Developing Processors

Implement a processor by defining a struct that satisfies the [sdk.Processor](<https://pkg.go.dev/github.com/conduitio/conduit-processor-sdk#Processor) interface.
Implement a processor by defining a struct that satisfies the [sdk.Processor](https://pkg.go.dev/github.com/conduitio/conduit-processor-sdk#Processor) interface.


Processors follow a lifecycle of: Configure, Open, Process, and Teardown, However a simple processor can be created with only Specification and Process being overridden. There are other optional functions that help with the configuration of more complex processors such as: Configure, Open, Teardown and MiddlewareOptions.

Further information on developing a processor can be found at the following link(s):

- [Build you own](/docs/processors/standalone/building)
- [How it works](/docs/processors/standalone/how-it-works)
- [Build you own](/docs/developing/processors/building)
- [How it works](/docs/developing/processors/how-it-works)