Skip to content

Commit e9b849a

Browse files
authored
fix: Add theme update step to local docs development instructions (#261)
1 parent 6baaa20 commit e9b849a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

CONTRIBUTING_DOCS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,13 @@ If you're an employee of F5/NGINX, also read [For F5/NGINX Employees](./F5-NGINX
1616
You will need to install Hugo _or_ Docker to build and preview docs in your local development environment.
1717
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.
1818

19-
**NOTE**: We are currently running [Hugo v0.134.2](https://github.com/gohugoio/hugo/releases/tag/v0.134.2) in production.
20-
2119

2220
Although not a strict requirement, markdown-link-check is also used in documentation development.
2321

2422
If you have [Docker](https://www.docker.com/get-started/) installed, there are fallbacks for all requirements in the [Makefile](Makefile), meaning you don't need to install them.
2523

2624
- [Installing Hugo](https://gohugo.io/getting-started/installing/)
25+
- **NOTE**: We are currently running [Hugo v0.134.2](https://github.com/gohugoio/hugo/releases/tag/v0.134.2) in production.
2726
- [Installing markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#installation)
2827
- [Installing markdown-link-check](https://github.com/tcort/markdown-link-check?tab=readme-ov-file#installation).
2928

@@ -35,7 +34,11 @@ The configuration files are as follows:
3534

3635
## Local Docs Development
3736

38-
To build the documentation locally, use the `make` command in the documentation folder with these targets:
37+
To build the documentation locally, use the `make` command in the documentation folder. First make sure you have the latest version of our Hugo theme with:
38+
39+
`make hugo-update`
40+
41+
Once you've updated the theme, you can use these targets:
3942

4043
```text
4144
make watch - Runs a local Hugo server, allowing for changes to be previewed in a browser.

0 commit comments

Comments
 (0)