Skip to content

docs: fix typos #853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
false200 wants to merge 1 commit into from
+9 −9
Closed

docs: fix typos #853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developer-guide/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,5 +215,5 @@ Go provides the `gofmt` tool, which can be used for formatting your code.

We kindly invite everyone interested in `urunc` to join our
[Slack channel](https://cloud-native.slack.com/archives/C08V201G35J).
To directly communicate with the maintainers, feel free to drop an email At
To directly communicate with the maintainers, feel free to drop an email at
[`urunc`'s maintainers' mailing list](cncf-urunc-maintainers@lists.cncf.io )
2 changes: 1 addition & 1 deletion docs/developer-guide/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ by running the:
- end-to-end tests: `sudo make e2etest`

> Note: When running `make` commands for `urunc` that will use go (i.e. build,
> unitest, e2etest) you might need to specify the path to the go binary
> unittest, e2etest) you might need to specify the path to the go binary
with `sudo GO=$(which go) make`.

## Next Steps
Expand Down
6 changes: 3 additions & 3 deletions docs/package/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ required annotations are the following:
- `com.urunc.unikernel.cmdline`: The application's cmdline to pass to the
unikernel.

Except of the above, `urunc` accepts the following optional annotations:
Except for the above, `urunc` accepts the following optional annotations:

- `com.urunc.unikernel.initrd`: The path to the initrd of the unikernel inside
the container's rootfs.
Expand Down Expand Up @@ -88,7 +88,7 @@ package unikernels in OCI images with `urunc`'s annotations.
### bunny

In an effort to simplify the process of building various unikernels, we built
[bunny](https://github.com/nubificus/bunny). Except of building unikernels [bunny](https://github.com/nubificus/bunny)
[bunny](https://github.com/nubificus/bunny). Except for building unikernels [bunny](https://github.com/nubificus/bunny)
can also pack existing unikernels (whether locally or from OCI images) as OCI images
for `urunc`. At its core [bunny](https://github.com/nubificus/bunny) leverages
[buildkit's LLB](https://github.com/moby/buildkit?tab=readme-ov-file#exploring-llb),
Expand All @@ -113,7 +113,7 @@ can handle the following *instructions*:
To further extend the functionality and provide a common interface to facilitate
unikernel building, we defined `bunnyfile`. It is a YAML-based special file that
[bunny](https://github.com/nubificus/bunny) transforms to LLB with all the
necessary steps to build the respective unikernel. Except of building
necessary steps to build the respective unikernel. Except for building
unikernels, [bunny](https://github.com/nubificus/bunny) can also be used to build or append files in the unikernel's
rootfs.

Expand Down
2 changes: 1 addition & 1 deletion docs/package/pre-built.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ docker build -f Containerfile -t urunc/prebuilt/network-mirage-hvt:test .
## Using `bunix`

In the case of [bunix](https://github.com/nubificus/bunix) we need to clone the whole
repository in the same directly as the
repository in the same directory as the
unikernel. Then, we simply need to edit the `args.nix` file as:

```Nix
Expand Down
2 changes: 1 addition & 1 deletion docs/package/rootfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ docker build -f Containerfile -t urunc/prebuilt/redis-rumprun-hvt:test .

### Using `bunix`

In the case of [bunix](https://github.com/nubificus/bunix) we need the whole repository in the same directly as
In the case of [bunix](https://github.com/nubificus/bunix) we need the whole repository in the same directory as
the unikernel. Then, we simply need to edit the `args.nix` file. For our
pre-built Redis [Rumprun](https://github.com/nubificus/rumprun) unikernel we can define the files as:

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/existing-container-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ treated as a separate argument.
parameters. If too many or very long environment variables are passed, the
boot process will fail once that limit is exceeded.

Especially, for CLI argument handing, `urunc` follows a simple convention. All
Especially, for CLI argument handling, `urunc` follows a simple convention. All
multi-word CLI arguments are wrapped in single quotes and the init process (or
application) is expected to reconstruct them properly.

For all the above reasons, we strongly recommend using a dedicated init process.
We provide [urunit](https://github.com/nubificus/urunit#); a lightweight init
We provide [urunit](https://github.com/nubificus/urunit); a lightweight init
designed specifically for `urunc`. It performs the following actions:

1. Sets default route through eth0. This is necessary when we deploy
Expand Down