Skip to content

Commit 5f3dffd

Browse files
AlekseyKorzikgitbook-bot
authored andcommitted
GITBOOK-36: Fix links and formatting. Note that Private Network link is temp and should be replaced after PR
1 parent 12bd30c commit 5f3dffd

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

getting-started/installation.md

+17-19
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In this tutorial, you'll learn how to install and run a job with the Bacalhau cl
1414
The Bacalhau client is a command-line interface (CLI) that allows you to submit jobs to the Bacalhau. The client is available for Linux, macOS, and Windows. You can also run the Bacalhau client in a Docker container.
1515

1616
{% hint style="info" %}
17-
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/).
17+
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/running-node/).
1818
{% endhint %}
1919

2020
#### Step 1.1 - Install the Bacalhau CLI
@@ -38,7 +38,7 @@ docker image rm -f ghcr.io/bacalhau-project/bacalhau:latest # Remove old image i
3838
docker pull ghcr.io/bacalhau-project/bacalhau:latest
3939
```
4040

41-
To run a specific version of Bacalhau using Docker, use the command docker run -it ghcr.io/bacalhau-project/bacalhau:v1.0.3, where "v1.0.3" is the version you want to run; note that the "latest" tag will not re-download the image if you have an older version. For more information on running the Docker image, check out the Bacalhau docker image example.
41+
To run a specific version of Bacalhau using Docker, use the command `docker run -it ghcr.io/bacalhau-project/bacalhau:v1.0.3`, where `v1.0.3` is the version you want to run; note that the `latest` tag will not re-download the image if you have an older version. For more information on running the Docker image, check out the Bacalhau docker image example.
4242
{% endtab %}
4343
{% endtabs %}
4444

@@ -60,7 +60,7 @@ docker run -it ghcr.io/bacalhau-project/bacalhau:latest version
6060
{% endtab %}
6161
{% endtabs %}
6262

63-
If you're wondering which server is being used, the Bacalhau Project has a [public Bacalhau server network](../setting-up/running-node/quick-start.md#ensure-your-storage-server-is-running) that's shared with the community. This server allows you to launch your jobs from your computer without maintaining a compute cluster on your own.
63+
If you're wondering which server is being used, the Bacalhau Project has a demo network that's shared with the community. This network allows you to familiarize with Bacalhau's capabilities and launch jobs from your computer without maintaining a compute cluster on your own.
6464

6565
### Step 2 - Submit a Hello World job
6666

@@ -105,7 +105,7 @@ Checking job status...
105105
The `job_id` above is shown in its full form. For convenience, you can use the shortened version, in this case: `9d20bbad`.
106106

107107
{% hint style="info" %}
108-
While this command is designed to resemble Docker's run command which you may be familiar with, Bacalhau introduces a whole new set of [flags](broken-reference/) to support its computing model.
108+
While this command is designed to resemble Docker's run command which you may be familiar with, Bacalhau introduces a whole new set of [flags](../dev/cli-reference/all-flags.md#docker-run) to support its computing model.
109109
{% endhint %}
110110
{% endtab %}
111111

@@ -154,7 +154,7 @@ CREATED ID JOB STATE PUBLI
154154
When it says `Completed`, that means the job is done, and we can get the results.
155155

156156
{% hint style="info" %}
157-
For a comprehensive list of flags you can pass to the list command check out [the related CLI Reference page](broken-reference/)
157+
For a comprehensive list of flags you can pass to the list command check out [the related CLI Reference page](../dev/cli-reference/all-flags.md)
158158
{% endhint %}
159159

160160
#### Step 3.2 - Job information:
@@ -168,19 +168,17 @@ bacalhau describe 9d20bbad
168168
Let's take a look at the results of the command execution in the terminal:
169169

170170
```shell
171-
172-
Job:
173-
APIVersion: V1beta2
174-
Metadata:
175-
ClientID: 0ff57b2521334a92e9ddab4b2f8202c887b1eaa35d2aa945ab0e247d3bc0aa88
176-
CreatedAt: "2023-12-21T15:24:31.750306239Z"
177-
ID: 0ed7617d-d5ff-40f7-8411-89830b3f3058
178-
Requester:
179-
RequesterNodeID: QmbxGSsM6saCTyKkiWSxhJCt6Fgj7M9cns1vzYtfDbB5Ws
180-
RequesterPublicKey: CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDEHTUAD1JzO0130W9vsaDGhU0PVgpcNjG3fYlE0sJ1BiBWENFuP4jx3Q9alcjNGhdRFdju0Mb/fidTOtJcPhxTdb+H6JxFP6HsADGes9jU4ylBU2SL2vfdb0KXzKdXjNHGGf4BuCGTcH07Oqxp209diK/cT7takL2fLjcgs1tM+6PzlfGzFqCPxvh9Sa0ek34mdmHjcp1XH8yjF1OKOuHvD+pYphqvOBL/2LEN+EBC4fz/QUnhUajCmKYO83MJcNUXSGxb4AN6K3DpVV+cJph7fj9ADdP7i996o2S4Gkz8W4Wpt/jICaPpkUjmyU3Jgcw7MHkZaYEzWxnnO2J936+pAgMBAAE=
181-
Spec:
182-
...
183-
171+
Job:
172+
APIVersion: V1beta2
173+
Metadata:
174+
ClientID: 0ff57b2521334a92e9ddab4b2f8202c887b1eaa35d2aa945ab0e247d3bc0aa88
175+
CreatedAt: "2023-12-21T15:24:31.750306239Z"
176+
ID: 0ed7617d-d5ff-40f7-8411-89830b3f3058
177+
Requester:
178+
RequesterNodeID: QmbxGSsM6saCTyKkiWSxhJCt6Fgj7M9cns1vzYtfDbB5Ws
179+
RequesterPublicKey: CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDEHTUAD1JzO0130W9vsaDGhU0PVgpcNjG3fYlE0sJ1BiBWENFuP4jx3Q9alcjNGhdRFdju0Mb/fidTOtJcPhxTdb+H6JxFP6HsADGes9jU4ylBU2SL2vfdb0KXzKdXjNHGGf4BuCGTcH07Oqxp209diK/cT7takL2fLjcgs1tM+6PzlfGzFqCPxvh9Sa0ek34mdmHjcp1XH8yjF1OKOuHvD+pYphqvOBL/2LEN+EBC4fz/QUnhUajCmKYO83MJcNUXSGxb4AN6K3DpVV+cJph7fj9ADdP7i996o2S4Gkz8W4Wpt/jICaPpkUjmyU3Jgcw7MHkZaYEzWxnnO2J936+pAgMBAAE=
180+
Spec:
181+
...
184182
```
185183

186184
This outputs all information about the job, including stdout, stderr, where the job was scheduled, and so on.
@@ -241,7 +239,7 @@ With that, you have just successfully run a job on Bacalhau! :fish:
241239

242240
Here are few resources that provide a deeper dive into running jobs with Bacalhau:
243241

244-
[How Bacalhau works](architecture.md) [Setting up Bacalhau](broken-reference) [Examples & Use Cases](broken-reference)
242+
[How Bacalhau works](architecture.md), [Setting up Bacalhau](broken-reference), [Examples & Use Cases](broken-reference)
245243

246244
### Support
247245

0 commit comments

Comments
 (0)