From fc362110459a78a66e7173aaa137216171bc1c1b Mon Sep 17 00:00:00 2001 From: Jen Gao Date: Mon, 22 Jul 2024 10:46:25 +0000 Subject: [PATCH] correct installation command & add python plugins --- site-src/contributing/devguide.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/site-src/contributing/devguide.md b/site-src/contributing/devguide.md index a25b0e77..cf856599 100644 --- a/site-src/contributing/devguide.md +++ b/site-src/contributing/devguide.md @@ -51,7 +51,7 @@ run static analysis against the code and generate Kubernetes CRDs. You can kick off an overall build from the top-level makefile: ```shell -make generate +make install ``` ### Submitting a Pull Request @@ -93,6 +93,12 @@ manually preview docs changes locally, you can install mkdocs and run: You might want to install [Python Vitural environment](https://docs.python.org/3/library/venv.html) to avoid conflicts. +Install the required plugins. + +```shell +pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin +``` + Once the build is complete, there would be a new folder called `site` generated, and you can deploy the website locally at port 8000 and run: ```shell