Skip to content

fix: Clarify CONTRIBUTING_DOCS #22

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 1 commit into from
Dec 10, 2024
Merged

fix: Clarify CONTRIBUTING_DOCS #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 4 additions & 6 deletions CONTRIBUTING_DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ 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.3](https://github.com/gohugoio/hugo/releases/tag/v0.134.3) in production.
**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.
Expand All @@ -38,11 +38,9 @@ The configuration files are as follows:
To build the documentation locally, use the `make` command in the documentation folder with these targets:

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