The instructions for local building the documentation locally, in a Docker environment (generated from the content/docs/contributing/docs.mdx file) are:
docker build -t ghcr.io/unikraft/docs:base --target base .
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
These are, however, inconsistent with the instructions in the top-level README.md file:
docker build -t ghcr.io/unikraft/docs:dev --target dev .
docker run -it --rm -v $(pwd):/docs -w /docs -p 3000:3000 ghcr.io/unikraft/docs:dev
They must be identical. Update the instructions in the contents/docs/contributing/docs.mdx file to match those in the README.md file.
The instructions for local building the documentation locally, in a Docker environment (generated from the
content/docs/contributing/docs.mdxfile) are:These are, however, inconsistent with the instructions in the top-level
README.mdfile:They must be identical. Update the instructions in the
contents/docs/contributing/docs.mdxfile to match those in theREADME.mdfile.