From 731f2afdf5ea18ca88aa0fbbe1a5300dfbccaf60 Mon Sep 17 00:00:00 2001 From: false200 <214800619+false200@users.noreply.github.com> Date: Wed, 29 Jul 2026 05:34:05 +0530 Subject: [PATCH] docs: fix typos Signed-off-by: false200 <214800619+false200@users.noreply.github.com> --- docs/developer-guide/contribute.md | 2 +- docs/developer-guide/development.md | 2 +- docs/package/index.md | 6 +++--- docs/package/pre-built.md | 2 +- docs/package/rootfs.md | 2 +- docs/tutorials/existing-container-linux.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developer-guide/contribute.md b/docs/developer-guide/contribute.md index 795c81b4e..2956014ef 100644 --- a/docs/developer-guide/contribute.md +++ b/docs/developer-guide/contribute.md @@ -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 ) diff --git a/docs/developer-guide/development.md b/docs/developer-guide/development.md index cf32dd9c1..6e94616cb 100644 --- a/docs/developer-guide/development.md +++ b/docs/developer-guide/development.md @@ -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 diff --git a/docs/package/index.md b/docs/package/index.md index 311eb98a3..ffad9fd59 100644 --- a/docs/package/index.md +++ b/docs/package/index.md @@ -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. @@ -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), @@ -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. diff --git a/docs/package/pre-built.md b/docs/package/pre-built.md index 4d7f8e130..4c48c2948 100644 --- a/docs/package/pre-built.md +++ b/docs/package/pre-built.md @@ -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 diff --git a/docs/package/rootfs.md b/docs/package/rootfs.md index ad4e13f50..ab7c1e032 100644 --- a/docs/package/rootfs.md +++ b/docs/package/rootfs.md @@ -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: diff --git a/docs/tutorials/existing-container-linux.md b/docs/tutorials/existing-container-linux.md index d597f7fce..0ccde2a29 100644 --- a/docs/tutorials/existing-container-linux.md +++ b/docs/tutorials/existing-container-linux.md @@ -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