Skip to content

Commit

Permalink
fix: fix typos in content folder
Browse files Browse the repository at this point in the history
  • Loading branch information
lterrac committed Mar 29, 2024
1 parent 63b3822 commit 4e4984d
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion content/community/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ software engineers, researchers, teachers, students and hobbyists. Periodic
meetings, hackathons and a consistent presence in open source events are central
to the well functioning of the community.

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

Public releases are planned to happen once every two months. In general, we aim
Expand Down
2 changes: 1 addition & 1 deletion content/docs/cli/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Simply run the following command to get started:
curl --proto '=https' --tlsv1.2 -sSf https://get.kraftkit.sh | sh
```

The above script will identify your host and guide you through an the
The above script will identify your host and guide you through the
installation process, including suggestions for how to receive updates. The
installer will try to use your native package manager.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/contributing/adding-to-the-app-catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Adding a new application requires the creation of:
Or the source code files may be scripts (in scripted / interpreted programming languages) that implement the application.
- [optional] Configuration and data files used by the application.
- A `Dockerfile` to generate the filesystem for the application.
The filesystem consists of the application binary executable (`ELF`) or scripts, depending libraries, configuration files, data files.
The filesystem consists of the application binary executable (`ELF`) or scripts, depending libraries, configuration files, and data files.
These files may either be pulled from an existing Docker image, or they may be build / copied from (source code) files provided by the user.
- A `Kraftfile` that details the build and run specification of the application.
- A `README.md` files that documents the steps required to build, run and test the application.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/internals/writing-tests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Generally, the following pattern is used for test suites:

`$LIBNAME_$TESTSUITENAME_testsuite`

An the following for test cases:
And the following for test cases:

`$LIBNAME_test_$TESTCASENAME`

Expand Down
10 changes: 5 additions & 5 deletions content/guides/baby-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: |
---

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

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

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

We welcome contributors and users on Discord and on GitHub.
If you are looking for a fun technical project in the area of operating systems, virtualization, come aboard on Discord.
We welcome contributors and users on Discord and GitHub.
If you are looking for a fun technical project in the area of operating systems, and virtualization, come aboard on Discord.
18 changes: 9 additions & 9 deletions content/guides/catalog-behind-the-scenes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: |
It shows what is happening behind the scenes and how you can get more control on the build and run phases.
---

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).
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).
It presents some hints into what's happening behind the scenes, but it aims to keep the user away for this.
This guide takes a deep dive into the internals of configuring, building and running Unikernel applications from the catalog.
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).
Expand Down Expand Up @@ -38,7 +38,7 @@ The `Kraftfile` defines the:
- root filesystem used to build the (embedded) initrd

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

```dockerfile
FROM --platform=linux/x86_64 nginx:1.25.3-bookworm AS build
Expand Down Expand Up @@ -141,13 +141,13 @@ Query it using:
curl http://localhost:8080
```

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

```bash
kraft net create -n 172.44.0.1/24 virbr0
```

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

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

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.
The example it's using a prebuilt kernel image.
The example is using a prebuilt kernel image.
The prebuilt [`base` kernel image](https://github.com/unikraft/catalog/tree/main/library/base) is pulled from the registry, from `unikraft.org/base`.
This happens during the run phase.

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

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

```dockerfile
FROM golang:1.21.3-bookworm AS build
Expand Down Expand Up @@ -243,7 +243,7 @@ kraft run -W -p 8080:8080 .

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

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

```bash
kraft net create -n 172.44.0.1/24 virbr0
```

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

```bash
qemu-system-x86_64 \
Expand Down

0 comments on commit 4e4984d

Please sign in to comment.