diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index e1d276cf31..0c03049059 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -15,7 +15,7 @@ In this tutorial, you'll learn how to install and run a job with the Bacalhau cl The Bacalhau client is a command-line interface (CLI) that allows you to submit jobs to the Bacalhau. The Bacalhau client is available for Linux, macOS, and Windows. You can also run the Bacalhau client in a Docker container. :::info -By default, you will submit to the Bacalhau public network, but the same CLI can be configured to submit to a private Bacalhau network. For more information, please read Running [Bacalhau on a Private Network](../next-steps/private-cluster). +By default, you will submit to the Bacalhau public network, but the same CLI can be configured to submit to a private Bacalhau network. For more information, please read Running [Bacalhau on a Private Network](../setting-up/networking-instructions/private-cluster). ::: ### Step 1.1 - Install the Bacalhau CLI diff --git a/docs/docs/integration/wasm-observe.md b/docs/docs/integration/wasm-observe.md index 1409a1f389..8f966e6f7e 100644 --- a/docs/docs/integration/wasm-observe.md +++ b/docs/docs/integration/wasm-observe.md @@ -6,18 +6,18 @@ sidebar_position: 4 # Observability for WebAssembly Workloads in Bacalhau Gain deeper insights into the WebAssembly (Wasm) jobs running on Bacalhau compute nodes using the -[Observe SDK](https://dev.dylibso.com/docs/category/observe-sdk/), an open-source library that unlocks modern observability for WebAssembly. This feature supplements the [host-level observability](/running-node/observability/) data with additional traces extracted from within the Wasm modules running on compute nodes in a Bacalhau network. +[Observe SDK](https://dev.dylibso.com/docs/category/observe-sdk/), an open-source library that unlocks modern observability for WebAssembly. This feature supplements the [host-level observability](../setting-up/running-node/observability) data with additional traces extracted from within the Wasm modules running on compute nodes in a Bacalhau network. ## Features - Extract telemetry data from Wasm workloads. Currently supports tracing, with logs and metrics coming soon. -- Data can be sent to the [same viewing destinations](/running-node/observability/#viewing) (ie. sinks) that are supported for the host-level data. +- Data can be sent to the [same viewing destinations](../setting-up/running-node/observability#viewing) (ie. sinks) that are supported for the host-level data. - Utilizes the same Trace ID as the host-level data, allowing for seamless visibility into the end-to-end execution of the job. ## Installing the SDK -- The Observe SDK is integrated with the default WebAssembly [Executor](/getting-started/architecture/#executor) provided by Bacalhau, so node operators are not required to integrate the SDK itself as long as a custom / pluggable Executor is not being used. +- The Observe SDK is integrated with the default WebAssembly [Executor](../getting-started/architecture#executor) provided by Bacalhau, so node operators are not required to integrate the SDK itself as long as a custom / pluggable Executor is not being used. - *(Optional)* For node operators using a custom Executer see [here](https://dev.dylibso.com/docs/observe/adapters/golang/opentelemetry) for instructions on how to integrate the Observe SDK. -- The SDK uses the same environment variables noted [here](/running-node/observability/#viewing) for sending data out to a viewing destination. +- The SDK uses the same environment variables noted [here](../setting-up/running-node/observability#viewing) for sending data out to a viewing destination. ## Usage diff --git a/docs/docs/setting-up/jobs/job-specification/job.md b/docs/docs/setting-up/jobs/job-specification/job.md index df5dc2b2f0..dfbb137bb2 100644 --- a/docs/docs/setting-up/jobs/job-specification/job.md +++ b/docs/docs/setting-up/jobs/job-specification/job.md @@ -30,7 +30,7 @@ Tasks: ## `job` Parameters - **Name** `(string : )`: A logical name to refer to the job. Defaults to job ID. - **Namespace** `(string: "default")`: The namespace in which the job is running. `ClientID` is used as a namespace in the public demo network. -- **Type** `(string: )`: The type of the job, such as `batch`, `ops`, `daemon` or `service`. You can learn more about the supported jobs types in the [Job Types](/topic-guides/job-types) guide. +- **Type** `(string: )`: The type of the job, such as `batch`, `ops`, `daemon` or `service`. You can learn more about the supported jobs types in the [Job Types](../job-types) guide. - **Priority** `(int: 0`): Determines the scheduling priority. - **Count** `(int: (Meta : nil): Arbitrary metadata associated with the job. diff --git a/docs/docs/setting-up/jobs/job-specification/spec-config.md b/docs/docs/setting-up/jobs/job-specification/spec-config.md index b45e698e3a..935636febf 100644 --- a/docs/docs/setting-up/jobs/job-specification/spec-config.md +++ b/docs/docs/setting-up/jobs/job-specification/spec-config.md @@ -28,7 +28,7 @@ Here are a few hypothetical examples to demonstrate how you might define `SpecCo } } ``` -Full Docker spec can be found [here](../other-specifications/engines/docker). +Full Docker spec can be found [here](../../other-specifications/engines/docker). ### S3 Publisher @@ -41,7 +41,7 @@ Full Docker spec can be found [here](../other-specifications/engines/docker). } } ``` -Full S3 Publisher can be found [here](../other-specifications/publishers/s3). +Full S3 Publisher can be found [here](../../other-specifications/publishers/s3). ### Local Directory Input Source @@ -54,6 +54,6 @@ Full S3 Publisher can be found [here](../other-specifications/publishers/s3). } } ``` -Full local source can be found [here](../other-specifications/sources/local). +Full local source can be found [here](../../other-specifications/sources/local.md). Remember, the exact keys and values in the `Params` map will vary depending on the specific requirements of the component being configured. Always refer to the individual component's documentation to understand the available parameters. \ No newline at end of file