Skip to content

Commit

Permalink
correct installation command & add python plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
jgao1025 committed Jul 22, 2024
1 parent 3513635 commit fc36211
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion site-src/contributing/devguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fc36211

Please sign in to comment.