Skip to content

Commit 9538fde

Browse files
committed
Updated the document with the correct steps for installing Docsy theme and use it with Hugo.
1 parent 8a97a3c commit 9538fde

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ git clone https://github.com/kubernetes/website.git
3030
cd website
3131
```
3232

33-
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:
33+
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme),
34+
which can be installed via npm. You can also download a pre-configured
35+
development container image that includes Hugo and Docsy. Additionally, a Git
36+
submodule is used for tools that generate the reference documentation.
3437

3538
### Windows
3639

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@ Figure 2. Working from a local fork to make your changes.
169169
```shell
170170
git clone git@github.com:<github_username>/website
171171
cd website
172-
git submodule update --init --recursive --depth 1
173172
```
174173

175174
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.
338337

339338
Alternately, install and use the `hugo` command on your computer:
340339

341-
1. Install the [Hugo](https://gohugo.io/getting-started/installing/) version specified in
340+
1. Install the [Hugo (Extended edition)](https://gohugo.io/getting-started/installing/) and [Node](https://nodejs.org/en) version specified in
342341
[`website/netlify.toml`](https://raw.githubusercontent.com/kubernetes/website/main/netlify.toml).
343342

344-
1. If you have not updated your website repository, the `website/themes/docsy` directory is empty.
345-
The site cannot build without a local copy of the theme. To update the website theme, run:
343+
1. Install any dependencies:
346344

347345
```shell
348-
git submodule update --init --recursive --depth 1
346+
npm ci
349347
```
350348

351349
1. In a terminal, go to your Kubernetes website repository and start the Hugo server:
352350

353351
```shell
354352
cd <path_to_your_repo>/website
353+
make serve
354+
```
355+
If you're on a Windows machine or unable to run the `make` command, use the following command:
356+
357+
```
355358
hugo server --buildFuture
356359
```
357360

0 commit comments

Comments
 (0)