Skip to content

Commit

Permalink
Fix broken links (#121)
Browse files Browse the repository at this point in the history
  • Loading branch information
hariso authored Aug 8, 2024
1 parent 5b1e464 commit ffdb67c
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/connectors/connector-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/connectors/connector-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/processors/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/processors/standalone/building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/processors/standalone/how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
44 changes: 30 additions & 14 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',

Expand Down Expand Up @@ -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',
Expand All @@ -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
},
]
},
],
],
Expand Down

0 comments on commit ffdb67c

Please sign in to comment.