Skip to content

Commit 9faa30f

Browse files
authored
doc: update links (#1923)
* update links * update processor specs * update ilnks
1 parent 10662c2 commit 9faa30f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+101
-101
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ The full example in our case would be:
221221
## Connectors
222222

223223
For the full list of available connectors, see
224-
the [Connector List](https://conduit.io/docs/connectors/connector-list). If
224+
the [Connector List](https://conduit.io/docs/using/connectors/list). If
225225
there's a connector that you're looking for that isn't available in Conduit,
226226
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)
227227
.
@@ -266,15 +266,15 @@ pipeline. It can either change the record (i.e. **transform** it) or **filter**
266266
it out based on some criteria.
267267

268268
Conduit provides a number of built-in processors, which can be used to manipulate fields,
269-
send requests to HTTP endpoints, and more, check [Builtin processors](https://conduit.io/docs/processors/builtin/)
269+
send requests to HTTP endpoints, and more, check [Builtin processors](https://conduit.io/docs/using/processors/builtin/)
270270
for the list of built-in processors and documentations.
271271

272-
Conduit also provides the ability to write your own [Standalone Processor](https://conduit.io/docs/processors/standalone/building),
273-
or you can use the built-in processor [`custom.javascript`](https://conduit.io/docs/processors/builtin/custom.javascript)
272+
Conduit also provides the ability to write your own [Standalone Processor](https://conduit.io/docs/developing/processors/building),
273+
or you can use the built-in processor [`custom.javascript`](https://conduit.io/docs/using/processors/builtin/custom.javascript)
274274
to write custom processors in JavaScript.
275275

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

279279
## API
280280

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

318-
- [Pipeline Semantics](https://conduit.io/docs/features/pipeline-semantics) explains the internals of how
318+
- [Pipeline Semantics](https://conduit.io/docs/core-concepts/pipeline-semantics) explains the internals of how
319319
a Conduit pipeline works.
320-
- [Pipeline Configuration Files](https://conduit.io/docs/pipeline-configuration-files)
320+
- [Pipeline Configuration Files](https://conduit.io/docs/using/pipelines/configuration-file)
321321
explains how you can define pipelines using YAML files.
322-
- [Processors](https://conduit.io/docs/processors/getting-started) contains examples and more information about
322+
- [Processors](https://conduit.io/docs/using/processors/getting-started) contains examples and more information about
323323
Conduit processors.
324-
- [Conduit Architecture](https://conduit.io/docs/getting-started/architecture)
324+
- [Conduit Architecture](https://conduit.io/docs/core-concepts/architecture)
325325
will give you a high-level overview of Conduit.
326326
- [Conduit Metrics](docs/metrics.md)
327327
provides more information about how Conduit exposes metrics.

docs/architecture-decision-records/20230123-pipeline-configuration-files.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ can be ( only incompatible changes cause the state to be deleted).
6565

6666
## Related
6767

68-
[Pipeline configuration files documentation](https://conduit.io/docs/pipeline-configuration-files)
68+
[Pipeline configuration files documentation](https://conduit.io/docs/using/pipelines/configuration-file)

docs/connectors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ and it can be run by others, as is, without them having to follow any additional
4040
If you want to create your own Conduit binary with a different set of built-in connectors,
4141
you can build-in an [existing connector](#the-list).
4242
Alternatively, you can also create your own
43-
[using the Conduit connector template or the Conduit Connector SDK](https://conduit.io/docs/connectors/building/).
43+
[using the Conduit connector template or the Conduit Connector SDK](https://conduit.io/docs/developing/connectors).
4444

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

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

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

8585
### Source & Destination
8686

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

9090
### The List
9191

92-
A full list of connectors is hosted here: <https://conduit.io/docs/connectors/connector-list/>.
92+
A full list of connectors is hosted here: <https://conduit.io/docs/using/connectors/list/>.

docs/design-documents/20231117-better-processors.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ plugin. We propose a similar approach to pluggable processors as we already have
180180
pluggable connectors. This means that processors would be loaded at startup and added
181181
to the processor plugin registry. Processors would be addressable using a similar naming
182182
scheme as connectors (more on
183-
[referencing connectors](https://conduit.io/docs/connectors/referencing)). Built-in
183+
[referencing connectors](https://conduit.io/docs/using/connectors/referencing)). Built-in
184184
processors would be created in a similar manner as built-in connectors, in that they
185185
would implement the same interface and could essentially be extracted into standalone
186186
processors (more info on
@@ -289,7 +289,7 @@ is to use Go comments for this purpose. We want to take a similar approach like
289289
[paramgen](https://github.com/ConduitIO/conduit-connector-sdk/tree/main/cmd/paramgen)
290290
in the connector SDK. The developer should be able to write the documentation once in
291291
a Go idiomatic way and use a tool to extract it into a format that can be used on the
292-
[documentation website](https://conduit.io/docs/introduction/getting-started/).
292+
[documentation website](https://conduit.io/docs).
293293

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

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

587587
#### Configuration
588588

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

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

609609
#### Example
610610

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

613613
```yaml
614614
processors:
@@ -626,7 +626,7 @@ processors:
626626
### `decode.json`
627627

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

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

665665
#### Configuration
666666

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

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

702702
#### Example
703703

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

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

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

@@ -774,7 +774,7 @@ processors:
774774
### `unwrap.debezium`
775775

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

@@ -799,14 +799,14 @@ processors:
799799
### `webhook.http`
800800

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

807807
#### Configuration
808808

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

811811
- `request.url` (required) - URL used in the HTTP request.
812812
- `request.method` (optional, default=`POST`) - HTTP request method to be used.

docs/design-documents/20240812-recover-from-pipeline-errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ reset.
8181

8282
### Dead-letter queue errors
8383

84-
If a DLQ ([Dead-letter queue](https://conduit.io/docs/features/dead-letter-queue))
84+
If a DLQ ([Dead-letter queue](https://conduit.io/docs/using/other-features/dead-letter-queue))
8585
is configured with a nack threshold greater than 0, the user has configured a
8686
DLQ and we should respect that. This means that if the nack threshold gets
8787
exceeded and the DLQ returns an error, that error should degrade the pipeline

docs/writing-a-connector-guidelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ destination connector.
8383

8484
### Use built-in connectors as examples
8585

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

pkg/plugin/processor/builtin/impl/avro/decode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ type decoder interface {
3636
type decodeConfig struct {
3737
// The field that will be decoded.
3838
//
39-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
39+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4040
Field string `json:"field" default:".Payload.After"`
4141

4242
fieldResolver sdk.ReferenceResolver

pkg/plugin/processor/builtin/impl/avro/decode_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/processor/builtin/impl/avro/encode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ type encoder interface {
3737
type encodeConfig struct {
3838
// The field that will be encoded.
3939
//
40-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
40+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4141
Field string `json:"field" default:".Payload.After"`
4242

4343
Schema schemaConfig `json:"schema"`

pkg/plugin/processor/builtin/impl/avro/encode_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/processor/builtin/impl/base64/decode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ type decodeConfig struct {
3838
// Field is the reference to the target field. Note that it is not allowed to
3939
// base64 decode the `.Position` field.
4040
//
41-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
41+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4242
Field string `json:"field" validate:"required,exclusion=.Position"`
4343
}
4444

pkg/plugin/processor/builtin/impl/base64/decode_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/processor/builtin/impl/base64/encode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type encodeConfig struct {
3939
// Field is a reference to the target field. Note that it is not allowed to
4040
// base64 encode the `.Position` field.
4141
//
42-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
42+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4343
Field string `json:"field" validate:"required,exclusion=.Position"`
4444
}
4545

pkg/plugin/processor/builtin/impl/base64/encode_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/processor/builtin/impl/error.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func (p *errorProcessor) Specification() (sdk.Specification, error) {
5555
Description: `Any time a record is passed to this processor it returns an error,
5656
which results in the record being sent to the DLQ if it's configured, or the pipeline stopping.
5757
58-
**Important:** Make sure to add a [condition](https://conduit.io/docs/processors/conditions)
58+
**Important:** Make sure to add a [condition](https://conduit.io/docs/using/processors/conditions)
5959
to this processor, otherwise all records will trigger an error.`,
6060
Version: "v0.1.0",
6161
Author: "Meroxa, Inc.",

pkg/plugin/processor/builtin/impl/field/convert.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type convertConfig struct {
4545
// Note that you can only convert fields in structured data under `.Key` and
4646
// `.Payload`.
4747
//
48-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
48+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4949
Field string `json:"field" validate:"required,regex=^\\.(Payload|Key).*"`
5050
// Type is the target field type after conversion, available options are: `string`, `int`, `float`, `bool`, `time`.
5151
Type string `json:"type" validate:"required,inclusion=string|int|float|bool|time"`

pkg/plugin/processor/builtin/impl/field/convert_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/plugin/processor/builtin/impl/field/exclude.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func NewExcludeProcessor(log.CtxLogger) sdk.Processor {
4141
type excludeConfig struct {
4242
// Fields is a comma separated list of target fields which should be excluded.
4343
//
44-
// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
44+
// For more information about the format, see [Referencing fields](https://conduit.io/docs/using/processors/referencing-fields).
4545
Fields []string `json:"fields" validate:"required"`
4646
}
4747

pkg/plugin/processor/builtin/impl/field/exclude_paramgen.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)