From 515adc61ada8bc7faafcad834fcc001978f77b0f Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:33:48 +0530 Subject: [PATCH] Typo and some doc enhacements (#1889) * Update README.md * Update CONTRIBUTING.md * Update connector_discovery.md * Update metrics.md --- CONTRIBUTING.md | 2 +- README.md | 12 ++++++------ docs/connector_discovery.md | 6 +++--- docs/metrics.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d238b1ff..5a0af61aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ on [Discord](https://discord.meroxa.com)! ## Submitting changes -We also value contributions in form of pull requests. When opening a PR please ensure: +We also value contributions in the form of pull requests. When opening a PR please ensure: - You have followed the [Code Guidelines](https://github.com/ConduitIO/conduit/blob/main/docs/code_guidelines.md). - There is no other [pull request](https://github.com/ConduitIO/conduit/pulls) for the same update/change. diff --git a/README.md b/README.md index 8db32b023..567b086b8 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Conduit pipelines are built out of simple building blocks which run in their own goroutines and are connected using Go channels. This makes Conduit pipelines incredibly performant on multi-core machines. Conduit guarantees the order of received records won't change, it also takes care of consistency by propagating -acknowledgments to the start of the pipeline only when a record is successfully +acknowledgements to the start of the pipeline only when a record is successfully processed on all destinations. Conduit connectors are plugins that communicate with Conduit via a gRPC @@ -204,7 +204,7 @@ for development purposes. The database type used can be configured with the `db.type` parameter (through any of the [configuration](#configuring-conduit) options in Conduit). -For example, the CLI flag to use a PostgresSQL database with Conduit is as +For example, the CLI flag to use a PostgreSQL database with Conduit is as follows: `-db.type=postgres`. Changing database parameters (e.g. the PostgreSQL connection string) is done @@ -265,12 +265,12 @@ A processor is a component that operates on a single record that flows through a pipeline. It can either change the record (i.e. **transform** it) or **filter** it out based on some criteria. -Conduit provides a number of builtin processors, which can be used to manipulate fields, +Conduit provides a number of built-in processors, which can be used to manipulate fields, send requests to HTTP endpoints, and more, check [Builtin processors](https://conduit.io/docs/processors/builtin/) -for the list of builtin processors and documentations. +for the list of built-in processors and documentations. Conduit also provides the ability to write your own [Standalone Processor](https://conduit.io/docs/processors/standalone/building), -or you can use the builtin processor [`custom.javascript`](https://conduit.io/docs/processors/builtin/custom.javascript) +or you can use the built-in processor [`custom.javascript`](https://conduit.io/docs/processors/builtin/custom.javascript) to write custom processors in JavaScript. More detailed information as well as examples can be found in @@ -343,7 +343,7 @@ and let us know. When you are not sure how to do something please [open a discussion](https://github.com/ConduitIO/conduit/discussions) or hit us up on [Discord](https://discord.meroxa.com). -We also value contributions in form of pull requests. When opening a PR please +We also value contributions in the form of pull requests. When opening a PR please ensure: - You have followed diff --git a/docs/connector_discovery.md b/docs/connector_discovery.md index fc98fd232..e6ae1b668 100644 --- a/docs/connector_discovery.md +++ b/docs/connector_discovery.md @@ -15,13 +15,13 @@ connectors themselves (using their gRPC API). ## Referencing connectors -The name used to reference a connector in API requests (e.g. to createa new connector) comes in the following format: +The name used to reference a connector in API requests (e.g. to create a new connector) comes in the following format: `[PLUGIN-TYPE:]PLUGIN-NAME[@VERSION]` - `PLUGIN-TYPE` (`builtin`, `standalone` or `any`) - - Defines if the specified plugin should be builtin or standalone. - - If `any`, Conduit will use a standalone plugin if it exists and fall back to a builtin plugin. + - Defines if the specified plugin should be built-in or standalone. + - If `any`, Conduit will use a standalone plugin if it exists and fall back to a built-in plugin. - Default is `any`. - `PLUGIN-NAME` - Defines the name of the plugin as specified in the plugin specifications, it has to be an exact match. diff --git a/docs/metrics.md b/docs/metrics.md index b014edd7b..62b400993 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -53,7 +53,7 @@ A labeled metric is one where labels must be set before usage. In many cases, the already present metric types should be sufficient. Adding a new metric of an existing type is simple. Let's say we want to count -number of message processed, per pipeline. To do so we will define a labeled +number of messages processed, per pipeline. To do so we will define a labeled counter and increase the counter in source nodes, each time a message is read. ### Create a new labeled counter