From ffdb67c0a5d9b02e972dda3bf49a6af726efaa31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Haris=20Osmanagi=C4=87?= Date: Thu, 8 Aug 2024 15:14:14 +0200 Subject: [PATCH] Fix broken links (#121) --- docs/connectors/connector-lifecycle.mdx | 2 +- docs/connectors/connector-list.mdx | 2 +- docs/introduction.mdx | 6 +-- docs/processors/getting-started.mdx | 2 +- docs/processors/standalone/building.mdx | 2 +- docs/processors/standalone/how-it-works.mdx | 2 +- docusaurus.config.ts | 44 ++++++++++++++------- 7 files changed, 38 insertions(+), 22 deletions(-) diff --git a/docs/connectors/connector-lifecycle.mdx b/docs/connectors/connector-lifecycle.mdx index 8fc1075e..497dd0fb 100644 --- a/docs/connectors/connector-lifecycle.mdx +++ b/docs/connectors/connector-lifecycle.mdx @@ -20,7 +20,7 @@ in sources and destinations, as well as when lifecycle events are triggered. For more information on how to implement a connector see the [Connector SDK godocs](https://pkg.go.dev/github.com/conduitio/conduit-connector-sdk), the [Connector Template](https://github.com/ConduitIO/conduit-connector-template) -or the [guide for building a connector](/guides/build-a-conduit-connector). +or the [guide for building a connector](/docs/connectors/building-connectors/). ## Lifecycle diff --git a/docs/connectors/connector-list.mdx b/docs/connectors/connector-list.mdx index 2fff66d4..7c17eb6a 100644 --- a/docs/connectors/connector-list.mdx +++ b/docs/connectors/connector-list.mdx @@ -10,7 +10,7 @@ and [destination](https://github.com/ConduitIO/conduit/issues?q=is%3Aissue+label connector lists. ![scarf pixel conduit-site-docs-connectors](https://static.scarf.sh/a.png?x-pxid=2fa824d7-fd94-4cf9-a5c8-ea63c9860213) -Don't have time to wait? You can get started [building your own](/docs/connectors/building) in no time. +Don't have time to wait? You can get started [building your own](/docs/connectors/building-connectors/) in no time. ### Built-in vs Standalone diff --git a/docs/introduction.mdx b/docs/introduction.mdx index dbd09d72..2b8ef04b 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -15,10 +15,10 @@ Conduit is a data integration tool for software engineers. Its purpose is to help you move data from A to B. You can use Conduit to send data from Kafka to Postgres, between files and APIs, between [supported connectors](/docs/connectors/connector-list), -and [any datastore you can build a plugin for](/docs/connectors/building). +and [any datastore you can build a plugin for](/docs/connectors/building-connectors/). It's written in [Go](https://go.dev/), compiles to a binary, and is designed to -be easy to use and [deploy](/docs/running/binary). +be easy to use and [deploy](/docs/getting-started/installing-and-running?option=binary). Out of the box, Conduit comes with: @@ -27,7 +27,7 @@ Out of the box, Conduit comes with: - Processors - Observability -In this getting started guide we'll use a pre-built binary, but Conduit can also be run using [Docker](/docs/running/docker). +In this getting started guide we'll use a pre-built binary, but Conduit can also be run using [Docker](/docs/getting-started/installing-and-running?option=docker). ## Some of its features diff --git a/docs/processors/getting-started.mdx b/docs/processors/getting-started.mdx index f1ab7c07..fa4d13e6 100644 --- a/docs/processors/getting-started.mdx +++ b/docs/processors/getting-started.mdx @@ -79,7 +79,7 @@ pipelines: # other connectors ``` -The documentation about pipeline configuration files can be found [here](/docs/configuration/pipeline-configuration-files). +The documentation about how to configure processors in pipeline configuration files can be found [here](/docs/pipeline-configuration-files/specifications#processor). ### Using the [HTTP API](/api#get-/v1/processors) diff --git a/docs/processors/standalone/building.mdx b/docs/processors/standalone/building.mdx index 7fbb915b..1a1c4e44 100644 --- a/docs/processors/standalone/building.mdx +++ b/docs/processors/standalone/building.mdx @@ -441,7 +441,7 @@ GOARCH=wasm GOOS=wasip1 go build -o processor.wasm cmd/processor/main.go ``` **_Congratulations!_** Now you have a new standalone processor. -Check [Standalone processors](/docs/processors/standalone/index) for details on how to use your standalone +Check [Standalone processors](/docs/processors/standalone/#where-to-put-them) for details on how to use your standalone processor in a Conduit pipeline. :::note diff --git a/docs/processors/standalone/how-it-works.mdx b/docs/processors/standalone/how-it-works.mdx index e4057b07..4b051b3b 100644 --- a/docs/processors/standalone/how-it-works.mdx +++ b/docs/processors/standalone/how-it-works.mdx @@ -159,7 +159,7 @@ which can contain one of the following commands: ### `command_response` The processor should call this function to send a -[`CommandResponse`](#commandresponse) back to Conduit. The function returns 0 if +[`CommandResponse`](https://buf.build/conduitio/conduit-processor-sdk/docs/main:processor.v1#processor.v1.CommandResponse) back to Conduit. The function returns 0 if the response was successfully received, or an [error code](#error-codes). The memory address sent to `command_response` should contain a diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ddd1ce11..91073d9c 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -18,7 +18,7 @@ const config: Config = { organizationName: 'conduitio', // Usually your GitHub org/user name. projectName: 'conduit-site', // Usually your repo name. - onBrokenLinks: 'warn', + onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', onDuplicateRoutes: 'warn', @@ -207,6 +207,34 @@ const config: Config = { '@docusaurus/plugin-client-redirects', { redirects: [ + { + from: '/guides/build-a-conduit-connector', + to: '/docs/connectors/building-connectors/', + }, + { + from: '/docs/connectors/building', + to: '/docs/connectors/building-connectors/', + }, + { + from: '/docs/running/docker', + to: '/docs/getting-started/installing-and-running?option=docker', + }, + { + from: '/docs/running/binary', + to: '/docs/getting-started/installing-and-running?option=binary', + }, + { + from: '/docs/running/homebrew', + to: '/docs/getting-started/installing-and-running?option=homebrew', + }, + { + from: '/docs/running/source', + to: '/docs/getting-started/installing-and-running?option=source', + }, + { + from: '/docs/configuration/pipeline-configuration-files', + to: '/docs/pipeline-configuration-files/', + }, { from: '/docs/introduction/getting-started', to: '/docs', @@ -219,19 +247,7 @@ const config: Config = { from: '/docs/connectors/output-formats', to: '/docs/connectors/configuration-parameters/output-format' } - ], - createRedirects(existingPath) { - if (existingPath.includes('/docs/running')) { - const installingPath = '/docs/getting-started/installing-and-running' - return [ - existingPath.replace('/docs/running/binary', installingPath), - existingPath.replace('/docs/running/docker', installingPath), - existingPath.replace('/docs/running/homebrew', installingPath), - existingPath.replace('/docs/running/source', installingPath), - ]; - } - return undefined; // Return a falsy value: no redirect created - }, + ] }, ], ],