Skip to content

Commit 70e3bcc

Browse files
lterracStefanJum
authored andcommitted
guides: Fix typos in baby-steps and catalog-behind-the-scenes
Signed-off-by: Luca Terracciano <terraccianoluca@gmail.com>
1 parent 2c16ba1 commit 70e3bcc

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

content/guides/baby-steps.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: |
55
---
66

77
It does so in the context of a vibrant community consisting of highly skilled software engineers, researchers, teachers, students and hobbyists.
8-
Periodic meetings, hackathons and a consistent presence in open source events are central to the well functioning of the community.
8+
Periodic meetings, hackathons and a consistent presence in open-source events are central to the well functioning of the community.
99

10-
We use a guidelines for development and maintenance to ensure the creation of high quality code.
10+
We use guidelines for development and maintenance to ensure the creation of high-quality code.
1111

1212
Public releases are planned to happen once every two months.
13-
In general, we aim for a public release to happen at the last Monday of each odd month (January, March, May, etc.)
13+
In general, we aim for a public release to happen on the last Monday of each odd month (January, March, May, etc.)
1414

15-
We welcome contributors and users on Discord and on GitHub.
16-
If you are looking for a fun technical project in the area of operating systems, virtualization, come aboard on Discord.
15+
We welcome contributors and users on Discord and GitHub.
16+
If you are looking for a fun technical project in the area of operating systems, and virtualization, come aboard on Discord.

content/guides/catalog-behind-the-scenes.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: |
55
It shows what is happening behind the scenes and how you can get more control on the build and run phases.
66
---
77

8-
The [guide on using the application catalog](/guides/using-the-app-catalog) provides the user-friendly information on using the Unikraft application registry and the [`catalog` repository](https://github.com/unikraft/catalog).
8+
The [guide on using the application catalog](/guides/using-the-app-catalog) provides user-friendly information on using the Unikraft application registry and the [`catalog` repository](https://github.com/unikraft/catalog).
99
It presents some hints into what's happening behind the scenes, but it aims to keep the user away for this.
1010
This guide takes a deep dive into the internals of configuring, building and running Unikernel applications from the catalog.
1111
It is aimed for those more technically inclined who would be interested in understanding what's happening behind the scenes and maybe [contribute to the application catalog](/docs/contributing/adding-to-the-app-catalog).
@@ -38,7 +38,7 @@ The `Kraftfile` defines the:
3838
- root filesystem used to build the (embedded) initrd
3939

4040
The root filesystem is generated from a `Dockerfile` specification, as configured in the `Kraftfile`.
41-
The `Dockerfile` specification collects the required files (binary executable, depending libraries, configuration files, data files):
41+
The `Dockerfile` specification collects the required files (binary executable, depending libraries, configuration files, and data files):
4242

4343
```dockerfile
4444
FROM --platform=linux/x86_64 nginx:1.25.3-bookworm AS build
@@ -141,13 +141,13 @@ Query it using:
141141
curl http://localhost:8080
142142
```
143143

144-
If you want use a bridge interface, first create the bridge interface as `root` (prefix with `sudo` if required):
144+
If you want to use a bridge interface, first create the bridge interface as `root` (prefix with `sudo` if required):
145145

146146
```bash
147147
kraft net create -n 172.44.0.1/24 virbr0
148148
```
149149

150-
An the run manually with `qemu-system-x86_64` as `root` (prefix with `sudo` if required):
150+
And then run manually with `qemu-system-x86_64` as `root` (prefix with `sudo` if required):
151151

152152
```bash
153153
qemu-system-x86_64 \
@@ -171,7 +171,7 @@ To close the running QEMU instance, use `Ctrl+a x` in the QEMU console.
171171
## HTTP Go Server
172172

173173
For the [`http-go1.21` bincompat example](https://github.com/unikraft/catalog/tree/main/examples/http-go1.21), there is no build phase, only a run phase.
174-
The example it's using a prebuilt kernel image.
174+
The example is using a prebuilt kernel image.
175175
The prebuilt [`base` kernel image](https://github.com/unikraft/catalog/tree/main/library/base) is pulled from the registry, from `unikraft.org/base`.
176176
This happens during the run phase.
177177

@@ -197,7 +197,7 @@ The `Kraftfile` defines:
197197
- the available run targets: currently only x86_64-based builds are available, and only KVM-based builds, using QEMU or Firecracker
198198

199199
The root filesystem is generated from a `Dockerfile` specification, as configured in the `Kraftfile`.
200-
The `Dockerfile` specification collects the required files (binary executable, depending libraries, configuration files, data files):
200+
The `Dockerfile` specification collects the required files (binary executable, depending libraries, configuration files, and data files):
201201

202202
```dockerfile
203203
FROM golang:1.21.3-bookworm AS build
@@ -243,7 +243,7 @@ kraft run -W -p 8080:8080 .
243243

244244
1. It pulls the kernel package from the registry, from `unikraft.org/base:latest`.
245245
1. It generates the root filesystem, via BuildKit from the `Dockerfile` specification.
246-
The generation of the root filesystem implies the building the Go source code files into a binary executable (`ELF`).
246+
The generation of the root filesystem implies the building of the Go source code files into a binary executable (`ELF`).
247247
The executable, together with the depending libraries is then extracted into the root filesystem.
248248
1. It packs the root filesystem in an initial ramdisk (initrd).
249249
1. It runs the kernel attaching the initrd and using the command line in the specification: `/http_server`.
@@ -316,13 +316,13 @@ Query it using:
316316
curl http://localhost:8080
317317
```
318318

319-
If you want use a bridge interface, first create the bridge interface as `root` (prefix with `sudo` if required):
319+
If you want to use a bridge interface, first create the bridge interface as `root` (prefix with `sudo` if required):
320320

321321
```bash
322322
kraft net create -n 172.44.0.1/24 virbr0
323323
```
324324

325-
An the run manually with `qemu-system-x86_64` as `root` (prefix with `sudo` if required):
325+
And then run manually with `qemu-system-x86_64` as `root` (prefix with `sudo` if required):
326326

327327
```bash
328328
qemu-system-x86_64 \

0 commit comments

Comments
 (0)