Skip to content

Commit

Permalink
doc: update links (#1923)
Browse files Browse the repository at this point in the history
* update links

* update processor specs

* update ilnks
  • Loading branch information
raulb authored Oct 21, 2024
1 parent 10662c2 commit 9faa30f
Show file tree
Hide file tree
Showing 58 changed files with 101 additions and 101 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ The full example in our case would be:
## Connectors

For the full list of available connectors, see
the [Connector List](https://conduit.io/docs/connectors/connector-list). If
the [Connector List](https://conduit.io/docs/using/connectors/list). If
there's a connector that you're looking for that isn't available in Conduit,
please file an [issue](https://github.com/ConduitIO/conduit/issues/new?assignees=&labels=triage&template=3-connector-request.yml&title=Connector%3A+%3Cresource%3E+%5BSource%2FDestination%5D)
.
Expand Down Expand Up @@ -266,15 +266,15 @@ pipeline. It can either change the record (i.e. **transform** it) or **filter**
it out based on some criteria.

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/)
send requests to HTTP endpoints, and more, check [Builtin processors](https://conduit.io/docs/using/processors/builtin/)
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 built-in processor [`custom.javascript`](https://conduit.io/docs/processors/builtin/custom.javascript)
Conduit also provides the ability to write your own [Standalone Processor](https://conduit.io/docs/developing/processors/building),
or you can use the built-in processor [`custom.javascript`](https://conduit.io/docs/using/processors/builtin/custom.javascript)
to write custom processors in JavaScript.

More detailed information as well as examples can be found in
the [Processors documentation](https://conduit.io/docs/processors/getting-started).
the [Processors documentation](https://conduit.io/docs/using/processors/getting-started).

## API

Expand Down Expand Up @@ -315,13 +315,13 @@ visit [Conduit.io/docs](https://conduit.io/docs).
If you are interested in internals of Conduit we have prepared some technical
documentation:

- [Pipeline Semantics](https://conduit.io/docs/features/pipeline-semantics) explains the internals of how
- [Pipeline Semantics](https://conduit.io/docs/core-concepts/pipeline-semantics) explains the internals of how
a Conduit pipeline works.
- [Pipeline Configuration Files](https://conduit.io/docs/pipeline-configuration-files)
- [Pipeline Configuration Files](https://conduit.io/docs/using/pipelines/configuration-file)
explains how you can define pipelines using YAML files.
- [Processors](https://conduit.io/docs/processors/getting-started) contains examples and more information about
- [Processors](https://conduit.io/docs/using/processors/getting-started) contains examples and more information about
Conduit processors.
- [Conduit Architecture](https://conduit.io/docs/getting-started/architecture)
- [Conduit Architecture](https://conduit.io/docs/core-concepts/architecture)
will give you a high-level overview of Conduit.
- [Conduit Metrics](docs/metrics.md)
provides more information about how Conduit exposes metrics.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ can be ( only incompatible changes cause the state to be deleted).

## Related

[Pipeline configuration files documentation](https://conduit.io/docs/pipeline-configuration-files)
[Pipeline configuration files documentation](https://conduit.io/docs/using/pipelines/configuration-file)
6 changes: 3 additions & 3 deletions docs/connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ and it can be run by others, as is, without them having to follow any additional
If you want to create your own Conduit binary with a different set of built-in connectors,
you can build-in an [existing connector](#the-list).
Alternatively, you can also create your own
[using the Conduit connector template or the Conduit Connector SDK](https://conduit.io/docs/connectors/building/).
[using the Conduit connector template or the Conduit Connector SDK](https://conduit.io/docs/developing/connectors).

Once you have chosen a connector to be built-in, you can:

Expand Down Expand Up @@ -80,7 +80,7 @@ In addition to built-in connectors, Conduit can be used together with standalone
to enable even more data streaming use cases.
The Conduit team and other community developers create and maintain standalone connectors.

Learn more about how you can install [standalone connectors to Conduit here](https://conduit.io/docs/connectors/installing).
Learn more about how you can install [standalone connectors to Conduit here](https://conduit.io/docs/using/connectors/installing).

### Source & Destination

Expand All @@ -89,4 +89,4 @@ to write to a downstream data store.

### The List

A full list of connectors is hosted here: <https://conduit.io/docs/connectors/connector-list/>.
A full list of connectors is hosted here: <https://conduit.io/docs/using/connectors/list/>.
26 changes: 13 additions & 13 deletions docs/design-documents/20231117-better-processors.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ plugin. We propose a similar approach to pluggable processors as we already have
pluggable connectors. This means that processors would be loaded at startup and added
to the processor plugin registry. Processors would be addressable using a similar naming
scheme as connectors (more on
[referencing connectors](https://conduit.io/docs/connectors/referencing)). Built-in
[referencing connectors](https://conduit.io/docs/using/connectors/referencing)). Built-in
processors would be created in a similar manner as built-in connectors, in that they
would implement the same interface and could essentially be extracted into standalone
processors (more info on
Expand Down Expand Up @@ -289,7 +289,7 @@ is to use Go comments for this purpose. We want to take a similar approach like
[paramgen](https://github.com/ConduitIO/conduit-connector-sdk/tree/main/cmd/paramgen)
in the connector SDK. The developer should be able to write the documentation once in
a Go idiomatic way and use a tool to extract it into a format that can be used on the
[documentation website](https://conduit.io/docs/introduction/getting-started/).
[documentation website](https://conduit.io/docs).

We can use the same tool to extract the documentation into the connector specification
(see [processor lifecycle](#processor-lifecycle)). This way the same documentation can
Expand Down Expand Up @@ -577,7 +577,7 @@ processors:
### `decode.avro`

This processor is the same as the old processor
[`decodewithschema`](https://conduit.io/docs/processors/builtin/#decodewithschemakey),
[`decodewithschema`](https://conduit.io/docs/using/processors/builtin/#decodewithschemakey),
except that it focuses solely on decoding Avro values. If we add support for more
formats in the future it will be in the shape of new processors. This way the
processors will be easier to discover and we can tailor the processor configuration
Expand All @@ -586,7 +586,7 @@ we can still reuse the same code for most of the processor.

#### Configuration

Taken from [existing docs](https://conduit.io/docs/processors/builtin/#configuration).
Taken from [existing docs](https://conduit.io/docs/using/processors/builtin/#configuration).

- `url` (required) - URL of the schema registry (e.g. `http://localhost:8085`).
- `auth.basic.username` (optional) - Configures the username to use with basic
Expand All @@ -608,7 +608,7 @@ Taken from [existing docs](https://conduit.io/docs/processors/builtin/#configura

#### Example

Taken from [existing docs](https://conduit.io/docs/processors/builtin/#example).
Taken from [existing docs](https://conduit.io/docs/using/processors/builtin/#example).

```yaml
processors:
Expand All @@ -626,7 +626,7 @@ processors:
### `decode.json`

This processor replaces the existing
[`parsejson`](https://conduit.io/docs/processors/builtin/#parsejsonkey) processor
[`parsejson`](https://conduit.io/docs/using/processors/builtin/#parsejsonkey) processor
and additionally gives the user the ability to specify which field should be decoded.
It takes raw data (string) from the target field, parses it as JSON and stores the
decoded structured data in the target field.
Expand All @@ -651,7 +651,7 @@ processors:
### `encode.avro`

This processor is the same as the old processor
[`encodewithschema`](https://conduit.io/docs/processors/builtin/#encodewithschemakey),
[`encodewithschema`](https://conduit.io/docs/using/processors/builtin/#encodewithschemakey),
except that it focuses solely on encoding Avro values. If we add support for more
formats in the future it will be in the shape of new processors. This way the
processors will be easier to discover and we can tailor the processor configuration
Expand All @@ -664,7 +664,7 @@ Differences compared to the old processor:

#### Configuration

Taken from [existing docs](https://conduit.io/docs/processors/builtin/#configuration-1).
Taken from [existing docs](https://conduit.io/docs/using/processors/builtin/#configuration-1).

- `url` (required) - URL of the schema registry (e.g. `http://localhost:8085`).
- `schema.strategy` (required, Enum: `preRegistered`,`autoRegister`) - Specifies which
Expand Down Expand Up @@ -701,7 +701,7 @@ Taken from [existing docs](https://conduit.io/docs/processors/builtin/#configura

#### Example

Taken from [existing docs](https://conduit.io/docs/processors/builtin/#example-1).
Taken from [existing docs](https://conduit.io/docs/using/processors/builtin/#example-1).

```yaml
processors:
Expand Down Expand Up @@ -749,7 +749,7 @@ We are skipping the design of this processor, as it will not be part of the
### `unwrap.kafkaconnect`

This processor together with `unwrap.debezium` replaces the existing
[`unwrap`](https://conduit.io/docs/processors/builtin/#unwrap) processor, but works
[`unwrap`](https://conduit.io/docs/using/processors/builtin/#unwrap) processor, but works
the same way under the hood. It additionally gives the user the ability to specify
which field is the source of the kafkaconnect record.

Expand All @@ -774,7 +774,7 @@ processors:
### `unwrap.debezium`

This processor together with `unwrap.kafkaconnect` replaces the existing
[`unwrap`](https://conduit.io/docs/processors/builtin/#unwrap) processor, but works
[`unwrap`](https://conduit.io/docs/using/processors/builtin/#unwrap) processor, but works
the same way under the hood. It additionally gives the user the ability to specify
which field is the source of the debezium record.

Expand All @@ -799,14 +799,14 @@ processors:
### `webhook.http`

This processor replaces the existing
[`httprequest`](https://conduit.io/docs/processors/builtin/#httprequest) processor,
[`httprequest`](https://conduit.io/docs/using/processors/builtin/#httprequest) processor,
but works the same way under the hood. It additionally gives the user the ability
to specify what is sent as the body and where the response body and status are
stored (configuration options `request.body`, `response.body` and `response.status`).

#### Configuration

Taken from [existing docs](https://conduit.io/docs/processors/builtin/#configuration-5).
Taken from [existing docs](https://conduit.io/docs/using/processors/builtin/#configuration-5).

- `request.url` (required) - URL used in the HTTP request.
- `request.method` (optional, default=`POST`) - HTTP request method to be used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ reset.

### Dead-letter queue errors

If a DLQ ([Dead-letter queue](https://conduit.io/docs/features/dead-letter-queue))
If a DLQ ([Dead-letter queue](https://conduit.io/docs/using/other-features/dead-letter-queue))
is configured with a nack threshold greater than 0, the user has configured a
DLQ and we should respect that. This means that if the nack threshold gets
exceeded and the DLQ returns an error, that error should degrade the pipeline
Expand Down
2 changes: 1 addition & 1 deletion docs/writing-a-connector-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ destination connector.

### Use built-in connectors as examples

Conduit's [built-in connectors](https://conduit.io/docs/connectors/connector-list/)
Conduit's [built-in connectors](https://conduit.io/docs/using/connectors/list/)
are great references that can be used when writing connectors. They are also the
first ones to be updated with latest SDK and protocol changes.

Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ type decoder interface {
type decodeConfig struct {
// The field that will be decoded.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Field string `json:"field" default:".Payload.After"`

fieldResolver sdk.ReferenceResolver
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/decode_paramgen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/encode.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type encoder interface {
type encodeConfig struct {
// The field that will be encoded.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Field string `json:"field" default:".Payload.After"`

Schema schemaConfig `json:"schema"`
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/encode_paramgen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/base64/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type decodeConfig struct {
// Field is the reference to the target field. Note that it is not allowed to
// base64 decode the `.Position` field.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Field string `json:"field" validate:"required,exclusion=.Position"`
}

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/base64/encode.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type encodeConfig struct {
// Field is a reference to the target field. Note that it is not allowed to
// base64 encode the `.Position` field.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Field string `json:"field" validate:"required,exclusion=.Position"`
}

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func (p *errorProcessor) Specification() (sdk.Specification, error) {
Description: `Any time a record is passed to this processor it returns an error,
which results in the record being sent to the DLQ if it's configured, or the pipeline stopping.
**Important:** Make sure to add a [condition](https://conduit.io/docs/processors/conditions)
**Important:** Make sure to add a [condition](https://conduit.io/docs/using/processors/conditions)
to this processor, otherwise all records will trigger an error.`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/convert.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ type convertConfig struct {
// Note that you can only convert fields in structured data under `.Key` and
// `.Payload`.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Field string `json:"field" validate:"required,regex=^\\.(Payload|Key).*"`
// Type is the target field type after conversion, available options are: `string`, `int`, `float`, `bool`, `time`.
Type string `json:"type" validate:"required,inclusion=string|int|float|bool|time"`
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/exclude.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func NewExcludeProcessor(log.CtxLogger) sdk.Processor {
type excludeConfig struct {
// Fields is a comma separated list of target fields which should be excluded.
//
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
Fields []string `json:"fields" validate:"required"`
}

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 9faa30f

Please sign in to comment.