kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated the document with the correct steps for installing Docsy theme and use it with Hugo.

pull/49638/head
Aman Shrivastava 2025-02-04 18:46:32 +05:30
parent 8a97a3cafd
commit 9538fde064
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -30,7 +30,10 @@ git clone https://github.com/kubernetes/website.git
cd website
```
The Kubernetes website uses git submodules. Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following:
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme),
which can be installed via npm. You can also download a pre-configured
development container image that includes Hugo and Docsy. Additionally, a Git
submodule is used for tools that generate the reference documentation.
### Windows

13
content/en/docs/contribute/new-content/open-a-pr.md
View File

@ -169,7 +169,6 @@ Figure 2. Working from a local fork to make your changes.
```shell
git clone git@github.com:<github_username>/website
cd website
git submodule update --init --recursive --depth 1
```
1. Navigate to the new `website` directory. Set the `kubernetes/website` repository as the `upstream` remote:
@ -338,20 +337,24 @@ variable to override this behaviour.
Alternately, install and use the `hugo` command on your computer:
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in
1. Install the [Hugo (Extended edition)](https://gohugo.io/getting-started/installing/) and [Node](https://nodejs.org/en) version specified in
[`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/main/netlify.toml).
1. If you have not updated your website repository, the `website/themes/docsy` directory is empty.
The site cannot build without a local copy of the theme. To update the website theme, run:
1. Install any dependencies:
```shell
git submodule update --init --recursive --depth 1
npm ci
```
1. In a terminal, go to your Kubernetes website repository and start the Hugo server:
```shell
cd <path_to_your_repo>/website
make serve
```
If you're on a Windows machine or unable to run the `make` command, use the following command:
```
hugo server --buildFuture
```