Skip to content

Commit 85ef335

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

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,20 @@ 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) via npm module. 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:
3434

3535
### Windows
3636

3737
```powershell
38-
# fetch submodule dependencies
39-
git submodule update --init --recursive --depth 1
38+
# install dependencies
39+
npm ci
4040
```
4141

4242
### Linux / other Unix
4343

4444
```bash
45-
# fetch submodule dependencies
46-
make module-init
45+
# install dependencies
46+
npm ci
4747
```
4848

4949
## Running the website using a container

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ 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
172+
npm ci # Use Node version specified in website/netlify.toml
173173
```
174174

175175
1. Navigate to the new `website` directory. Set the `kubernetes/website` repository as the `upstream` remote:
@@ -338,21 +338,20 @@ variable to override this behaviour.
338338

339339
Alternately, install and use the `hugo` command on your computer:
340340

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

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:
344+
1. Before starting the Hugo server, ensure the dependencies are installed by running:
346345

347346
```shell
348-
git submodule update --init --recursive --depth 1
347+
npm ci
349348
```
350349

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

353352
```shell
354353
cd <path_to_your_repo>/website
355-
hugo server --buildFuture
354+
make serve
356355
```
357356

358357
1. In a web browser, navigate to `http://localhost:1313`. Hugo watches the

0 commit comments

Comments
 (0)