From 0cd57ce0d3051edda3d7ce4dc3404c54a1983ed0 Mon Sep 17 00:00:00 2001 From: Adam Haffar Date: Wed, 16 Oct 2024 16:49:57 +0100 Subject: [PATCH 1/6] add processor template documentation --- .../standalone/conduit-processor-template.mdx | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/processors/standalone/conduit-processor-template.mdx diff --git a/docs/processors/standalone/conduit-processor-template.mdx b/docs/processors/standalone/conduit-processor-template.mdx new file mode 100644 index 00000000..0ad51f5b --- /dev/null +++ b/docs/processors/standalone/conduit-processor-template.mdx @@ -0,0 +1,44 @@ +--- +title: "Conduit Processor Template" +sidebar_position: 1 +--- + +## Initializing a Conduit Processor Project + +To begin the development of a custom Conduit processor, it is recommended developers should initialize their project using the [Conduit processor template](https://github.com/ConduitIO/conduit-processor-template). This template streamlines the setup process by providing a fundamental project structure, along with utility configurations for GitHub actions and a Makefile. + +Included in the Conduit Processor Template are: + +- Base code for processor's config and lifecycle. +- Sample unit tests to validate processor functionality. +- A preconfigured Makefile to assist with common build tasks. +- GitHub Actions Workflows for continuous integration including building, testing, linting, and automated release creation upon tag push. +- Dependabot configurations to automate dependency updates and minor version auto-merging. +- Issue and Pull Request templates for consistent contribution practices. +- A README template to guide project documentation. + +### Steps to Use the Processor Template +### Steps to Use the Processor Template + +1. On the repository's main page, select "Use this template". +2. Provide the new repository details as prompted. +3. Upon repository creation, clone it to your local development environment. +4. Execute the `./setup.sh` script with the desired module name, e.g., `./setup.sh github.com/awesome-org/conduit-processor-file`. +5. (Optional) Define code owners in the `CODEOWNERS` file. + +:::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. + +::: + +## Developing Processors + +Implement a processor by defining a struct that satisfies the [sdk.Processor]( Date: Wed, 23 Oct 2024 15:44:40 +0100 Subject: [PATCH 2/6] remove duplicate heading MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Lovro Mažgon --- docs/processors/standalone/conduit-processor-template.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/processors/standalone/conduit-processor-template.mdx b/docs/processors/standalone/conduit-processor-template.mdx index 0ad51f5b..1a44e41f 100644 --- a/docs/processors/standalone/conduit-processor-template.mdx +++ b/docs/processors/standalone/conduit-processor-template.mdx @@ -17,7 +17,6 @@ Included in the Conduit Processor Template are: - Issue and Pull Request templates for consistent contribution practices. - A README template to guide project documentation. -### Steps to Use the Processor Template ### Steps to Use the Processor Template 1. On the repository's main page, select "Use this template". From c5cfc049a7b5634a30cff8e865354a0ee9b5dc95 Mon Sep 17 00:00:00 2001 From: Adam Haffar Date: Wed, 23 Oct 2024 15:49:06 +0100 Subject: [PATCH 3/6] terminology consistency --- docs/processors/standalone/conduit-processor-template.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/processors/standalone/conduit-processor-template.mdx b/docs/processors/standalone/conduit-processor-template.mdx index 1a44e41f..9bac864d 100644 --- a/docs/processors/standalone/conduit-processor-template.mdx +++ b/docs/processors/standalone/conduit-processor-template.mdx @@ -9,7 +9,7 @@ To begin the development of a custom Conduit processor, it is recommended develo Included in the Conduit Processor Template are: -- Base code for processor's config and lifecycle. +- Base code for processor's configuration and lifecycle. - Sample unit tests to validate processor functionality. - A preconfigured Makefile to assist with common build tasks. - GitHub Actions Workflows for continuous integration including building, testing, linting, and automated release creation upon tag push. From 8b3e5b5b05d521e1f2bfc05c5452f32ee9d5432a Mon Sep 17 00:00:00 2001 From: Adam Haffar Date: Wed, 23 Oct 2024 15:49:54 +0100 Subject: [PATCH 4/6] remove .mdx from links --- docs/processors/standalone/conduit-processor-template.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/processors/standalone/conduit-processor-template.mdx b/docs/processors/standalone/conduit-processor-template.mdx index 9bac864d..0aa4ccc1 100644 --- a/docs/processors/standalone/conduit-processor-template.mdx +++ b/docs/processors/standalone/conduit-processor-template.mdx @@ -39,5 +39,5 @@ Processors follow a lifecycle of: Configure, Open, Process, and Teardown, Howeve Further information on developing a processor can be found at the following link(s): -- [Build you own](/docs/processors/standalone/building.mdx) -- [How it works](/docs/processors/standalone/how-it-works.mdx) \ No newline at end of file +- [Build you own](/docs/processors/standalone/building) +- [How it works](/docs/processors/standalone/how-it-works) \ No newline at end of file From 1621f0a058b40245a017a9195b0ef6d836f13c58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Barroso?= Date: Mon, 28 Oct 2024 18:47:12 +0100 Subject: [PATCH 5/6] fixes for processor template documentation (#179) * fixes * fix links --- .../1-processors/0-conduit-processor-template.mdx} | 11 ++++++----- .../1-processors/{0-building.mdx => 1-building.mdx} | 0 .../{1-how-it-works.mdx => 2-how-it-works.mdx} | 0 3 files changed, 6 insertions(+), 5 deletions(-) rename docs/{processors/standalone/conduit-processor-template.mdx => 2-developing/1-processors/0-conduit-processor-template.mdx} (87%) rename docs/2-developing/1-processors/{0-building.mdx => 1-building.mdx} (100%) rename docs/2-developing/1-processors/{1-how-it-works.mdx => 2-how-it-works.mdx} (100%) diff --git a/docs/processors/standalone/conduit-processor-template.mdx b/docs/2-developing/1-processors/0-conduit-processor-template.mdx similarity index 87% rename from docs/processors/standalone/conduit-processor-template.mdx rename to docs/2-developing/1-processors/0-conduit-processor-template.mdx index 0aa4ccc1..ec984290 100644 --- a/docs/processors/standalone/conduit-processor-template.mdx +++ b/docs/2-developing/1-processors/0-conduit-processor-template.mdx @@ -1,6 +1,5 @@ --- title: "Conduit Processor Template" -sidebar_position: 1 --- ## Initializing a Conduit Processor Project @@ -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]( Date: Thu, 14 Nov 2024 11:16:08 +0100 Subject: [PATCH 6/6] fix: typo --- docs/2-developing/1-processors/0-conduit-processor-template.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/2-developing/1-processors/0-conduit-processor-template.mdx b/docs/2-developing/1-processors/0-conduit-processor-template.mdx index ec984290..aab5ccd9 100644 --- a/docs/2-developing/1-processors/0-conduit-processor-template.mdx +++ b/docs/2-developing/1-processors/0-conduit-processor-template.mdx @@ -40,5 +40,5 @@ Processors follow a lifecycle of: Configure, Open, Process, and Teardown, Howeve Further information on developing a processor can be found at the following link(s): -- [Build you own](/docs/developing/processors/building) +- [Build your own](/docs/developing/processors/building) - [How it works](/docs/developing/processors/how-it-works)