From 1702b0544634cb8811c4fa60f28287ce440cde40 Mon Sep 17 00:00:00 2001 From: Eric Sandu Date: Sun, 3 May 2026 13:08:02 +0300 Subject: [PATCH 1/3] fix(docs): Fix README.md linter errors Refer to NPM as "npm" Signed-off-by: Eric Sandu --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d211cbde..cc4e581e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It is deployed on the [Unikraft website](https://unikraft.org/) It provides information for the latest version of [Unikraft](https://github.com/unikraft/unikraft) and [KraftKit](https://kraftkit.sh). Documentation is written in [MDX](https://mdxjs.com/) format. -Building and deploying it requires Node and NPM. +Building and deploying it requires Node and npm. You can build and run either natively or using Docker. ## Building and Testing Natively From b403dc17efcec7ae085f178f7f323e16b70c8702 Mon Sep 17 00:00:00 2001 From: Eric Sandu Date: Sun, 3 May 2026 12:22:57 +0300 Subject: [PATCH 2/3] fix(docs): Fix inconsistencies between README.md and contribution docs Signed-off-by: Eric Sandu --- content/docs/contributing/docs.mdx | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/content/docs/contributing/docs.mdx b/content/docs/contributing/docs.mdx index abe31451..656aecd0 100644 --- a/content/docs/contributing/docs.mdx +++ b/content/docs/contributing/docs.mdx @@ -68,17 +68,12 @@ Building the site inside a Docker environment is highly recommended, since you w To deploy the site, run (in the directory of the repository clone): ```console -docker build -t ghcr.io/unikraft/docs:base --target base . +docker build -t ghcr.io/unikraft/docs:dev --target dev . -docker run -it --rm -v $(pwd):/docs -w /docs -p 3000:3000 --entrypoint sh ghcr.io/unikraft/docs:base - -# The commands below should be used in the docker container - -yarn install -yarn run dev +docker run -it --rm -v $(pwd):/docs -v unikraft_modules:/docs/node_modules -w /docs -p 3000:3000 ghcr.io/unikraft/docs:dev ``` -You may need admin privileges to run the first 2 commands. +You may need admin privileges to run the commands. Open up your browser and point to http://localhost:3000 to check the deployed documentation website. #### Building the Website Natively @@ -95,8 +90,11 @@ These problems can be avoided by building the website inside a Docker environmen Then, to build and deploy the site, run: ```console -yarn install -yarn run dev +npm install + +npm run search-meta:gen + +npm run dev ``` As above, open up your browser and point to http://localhost:3000 to check the deployed documentation website. From 4a0ff14bb530bfb07da90d6dd517e5aea3268999 Mon Sep 17 00:00:00 2001 From: Eric Sandu Date: Sun, 3 May 2026 14:51:41 +0300 Subject: [PATCH 3/3] fix(docs): Fix docs.mdx linter errors Signed-off-by: Eric Sandu --- content/docs/contributing/docs.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/contributing/docs.mdx b/content/docs/contributing/docs.mdx index 656aecd0..097dfdbb 100644 --- a/content/docs/contributing/docs.mdx +++ b/content/docs/contributing/docs.mdx @@ -55,7 +55,7 @@ Building inside a Docker environment is **strongly recommended**, since you will You can build the site inside a Docker environment. For this, you will need to install Docker-CE. -You can do that by following the instructions [here](https://github.com/docker/docker-install), or by running: +You can do that by following the [install instructions](https://github.com/docker/docker-install), or by running: ```console curl -fsSL https://get.docker.com/ | sh @@ -80,7 +80,7 @@ Open up your browser and point to http://localhost:3000 to check the deployed do You can also build the site natively. For a native build, you need to install `node`. -You can do it by following the instructions [here](https://nodejs.org/en/download). +You can do it by following the [download instructions](https://nodejs.org/en/download). This may lead to errors due to different `node` versions or other environment problems. @@ -139,7 +139,7 @@ For the Unikraft documentation repository, used and useful linters are: - [`textlint`](https://textlint.github.io/) - [`jscpd`](https://github.com/kucherenko/jscpd) -To run the `super-linter` locally, follow the instructions from [here](https://github.com/github/super-linter/blob/main/docs/run-linter-locally.md). +To run the `super-linter` locally, follow the [setup instructions](https://github.com/github/super-linter/blob/main/docs/run-linter-locally.md). Note that this will require quite a lot of storage, since it will pull the `super-linter` Docker image. You will need to install Docker, following the [official documentation](https://docs.docker.com/install/). @@ -201,7 +201,7 @@ node --version # Check node version. ``` The `textlinter` will require installation of rules. -You can find a list of rules [here](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule). +Here you can find a [list of rules](https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule). ```console npm install textlint-rule-terminology