From 9e2b2714a7152c83642cac8338193e94d7cb936c Mon Sep 17 00:00:00 2001 From: Michael Hoepler <147169582+MichaelHoepler@users.noreply.github.com> Date: Thu, 25 Jan 2024 16:26:16 +0100 Subject: [PATCH] Fixing broken links --- .../setting-up/jobs/job-specification/index.md | 8 ++++++++ .../docker-workload-onboarding.md | 16 ++++++++-------- .../wasm-workload-onboarding.md | 10 +++++----- 3 files changed, 21 insertions(+), 13 deletions(-) create mode 100644 docs/docs/setting-up/jobs/job-specification/index.md diff --git a/docs/docs/setting-up/jobs/job-specification/index.md b/docs/docs/setting-up/jobs/job-specification/index.md new file mode 100644 index 0000000000..958fdcaade --- /dev/null +++ b/docs/docs/setting-up/jobs/job-specification/index.md @@ -0,0 +1,8 @@ +--- +sidebar_label: "Job specifications" +sidebar_position: 0 +--- +# Job specifications + +This directory contains instructions on how to setup specifications for jobs in Bacalhau. + diff --git a/docs/docs/setting-up/workload-onboarding/docker-workload-onboarding.md b/docs/docs/setting-up/workload-onboarding/docker-workload-onboarding.md index 67104b1bb7..79446f5f31 100644 --- a/docs/docs/setting-up/workload-onboarding/docker-workload-onboarding.md +++ b/docs/docs/setting-up/workload-onboarding/docker-workload-onboarding.md @@ -13,7 +13,7 @@ This section describes how to migrate a workload based on a Docker container int :::info -You can check out this example tutorial on [how to work with custom containers in Bacalhau](../setting-up/workload-onboarding/custom-containers/index.md) to see how we used all these steps together. +You can check out this example tutorial on [how to work with custom containers in Bacalhau](../workload-onboarding/custom-containers/index.md) to see how we used all these steps together. ::: @@ -42,7 +42,7 @@ To help provide a safe, secure network for all users, we add the following runti 1. **Limited Ingress/Egress Networking**: -All ingress/egress networking is limited as described in the [networking](../setting-up/networking-instructions/fundamentals.md) documentation. +All ingress/egress networking is limited as described in the [networking](../networking-instructions/fundamentals.md) documentation. You won't be able to pull `data/code/weights/` etc. from an external source. 2. **Data Passing with Docker Volumes**: @@ -73,7 +73,7 @@ We make the assumption that you are reading from a directory called `/inputs`, w :::info -You can specify which directory the data is written to with the [`--input`](../dev/cli-reference/all-flags.md#docker-run) CLI flag. +You can specify which directory the data is written to with the [`--input`](../../dev/cli-reference/all-flags.md#docker-run) CLI flag. ::: @@ -85,13 +85,13 @@ We make the assumption that you are writing to a directory called `/outputs`, wh :::info -You can specify which directory the data is written to with the [`--output-volumes`](../dev/cli-reference/all-flags.md#docker-run) CLI flag. +You can specify which directory the data is written to with the [`--output-volumes`](../../dev/cli-reference/all-flags.md#docker-run) CLI flag. ::: ### Step 3 - Build and Push Your Image To a Registry -At this step, you create (or update) a Docker image that Bacalhau will use to perform your task. You [build your image](https://docs.docker.com/engine/reference/commandline/build/) from your code and dependencies, then [push it](https://docs.docker.com/engine/reference/commandline/push/) to a public registry so that Bacalhau can access it. This is necessary for other Bacalhau nodes to run your container and execute the task. +At this step, you create (or update) a Docker image that Bacalhau will use to perform your task. You [build your image](https://docs.docker.com/engine/reference/commandline/build/) from your code and dependencies, then [push it](https://docs.docker.com/engine/reference/commandline/push/) to a public registry so that Bacalhau can access it. This is necessary for other Bacalhau nodes to run your container and execute the given task. :::caution @@ -169,9 +169,9 @@ do something useful Data is identified by its content identifier (CID) and can be accessed by anyone who knows the CID. You can use either of these methods to upload your data: -[Copy data from a URL to public storage](../setting-up/data-ingestion/from-url.md) -[Pin Data to public storage](../setting-up/data-ingestion/pin.md) -[Copy Data from S3 Bucket to public storage](../setting-up/data-ingestion/s3.md) +[Copy data from a URL to public storage](../data-ingestion/from-url.md) +[Pin Data to public storage](../data-ingestion/pin.md) +[Copy Data from S3 Bucket to public storage](../data-ingestion/s3.md) :::info You can mount your data anywhere on your machine, and Bacalhau will be able to run against that data diff --git a/docs/docs/setting-up/workload-onboarding/wasm-workload-onboarding.md b/docs/docs/setting-up/workload-onboarding/wasm-workload-onboarding.md index 7623a8abce..9202b6d4b2 100644 --- a/docs/docs/setting-up/workload-onboarding/wasm-workload-onboarding.md +++ b/docs/docs/setting-up/workload-onboarding/wasm-workload-onboarding.md @@ -49,9 +49,9 @@ For example, Rust users can specify the `wasm32-wasi` target to `rustup` and `ca Data is identified by its content identifier (CID) and can be accessed by anyone who knows the CID. You can use either of these methods to upload your data: - [Copy data from a URL to public storage](../setting-up/data-ingestion/from-url.md) - [Pin Data to public storage](../setting-up/data-ingestion/pin.md) - [Copy Data from S3 Bucket to public storage](../setting-up/data-ingestion/s3.md) + [Copy data from a URL to public storage](../data-ingestion/from-url.md) + [Pin Data to public storage](../data-ingestion/pin.md) + [Copy Data from S3 Bucket to public storage](../data-ingestion/s3.md) :::info You can mount your data anywhere on your machine, and Bacalhau will be able to run against that data @@ -136,8 +136,8 @@ $ bacalhau wasm run prog.wasm -e HELLO=world ## Examples -See [the Rust example](../examples/workload-onboarding/rust-wasm/index.md) for a workload that leverages WebAssembly support. - +See [the Rust example](../../examples/workload-onboarding/rust-wasm/index.md) for a workload that leverages WebAssembly support. +docs/docs/examples/workload-onboarding/rust-wasm/index.md ## Support