Skip to content

Commit ac4dc32

Browse files
author
nginx
committed
Pre OSS commit
2 parents 9793bd9 + bb23bdc commit ac4dc32

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

CONTRIBUTING_DOCS.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ 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.3](https://github.com/gohugoio/hugo/releases/tag/v0.134.3) in production.
19+
**NOTE**: We are currently running [Hugo v0.134.2](https://github.com/gohugoio/hugo/releases/tag/v0.134.2) in production.
2020

2121

2222
Although not a strict requirement, markdown-link-check is also used in documentation development.
@@ -38,11 +38,9 @@ The configuration files are as follows:
3838
To build the documentation locally, use the `make` command in the documentation folder with these targets:
3939

4040
```text
41-
make docs - Builds the documentation.
42-
make watch - Runs a Hugo server to automatically preview changes on a local browser. Use this if you want to preview
43-
the documentation locally before submitting a PR.
44-
make drafts - Runs a Hugo server, and displays documentation marked as drafts on a local browser. By default, drafts
45-
are not displayed.
41+
make watch - Runs a local Hugo server, allowing for changes to be previewed in a browser.
42+
make drafts - Runs a local Hugo server similar to the `watch` target, but displays documents marked with `draft: true` in their metadata.
43+
make docs - Builds the documentation in the local `public/` directory.
4644
make hugo-get - Updates the go module file with the latest version of the theme.
4745
make hugo-tidy - Removes unnecessary dependencies from the go module file.
4846
make hugo-update - Runs the hugo-get and hugo-tidy targets in sequence.

0 commit comments

Comments
 (0)