Skip to content

Fix: update per user self-build feedback #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 18, 2025
Merged

Fix: update per user self-build feedback #261

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce82c22
Fix: update per user self-build feedback
mjang Mar 6, 2025
90289cd
Merge branch 'main' into update-contributing-docs
mjang Mar 6, 2025
acccbf3
Merge branch 'main' into update-contributing-docs
ADubhlaoich Mar 13, 2025
8b6db8c
Merge branch 'main' into update-contributing-docs
ADubhlaoich Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions CONTRIBUTING_DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@ If you're an employee of F5/NGINX, also read [For F5/NGINX Employees](./F5-NGINX
You will need to install Hugo _or_ Docker to build and preview docs in your local development environment.
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.

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


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

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.

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

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

## Local Docs Development

To build the documentation locally, use the `make` command in the documentation folder with these targets:
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:

`make hugo-update`

Once you've updated the theme, you can use these targets:

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