Skip to content

Commit

Permalink
fixes for processor template documentation (#179)
Browse files Browse the repository at this point in the history
* fixes

* fix links
  • Loading branch information
raulb authored Oct 28, 2024
1 parent 484551c commit 1621f0a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
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)

0 comments on commit 1621f0a

Please sign in to comment.