Skip to content

Commit 7c18e31

Browse files
JTorreGJTorreG
authored
Merge branch 'main' into native-metrics
2 parents b484b6a + 63bcadd commit 7c18e31

File tree

667 files changed

+4073
-3045
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

667 files changed

+4073
-3045
lines changed

‎.github/ISSUE_TEMPLATE/feature_request.md renamed to ‎.github/ISSUE_TEMPLATE/1-feature_request.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/bug_report.md renamed to ‎.github/ISSUE_TEMPLATE/2-bug_report.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/3-story_task.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Story task
3+
about: This template is for a story or task, encompassing a single work item for completion
4+
title: ""
5+
labels: "documentation"
6+
projects: ["nginxinc/32"]
7+
assignees: ""
8+
---
9+
10+
*Remove italicized directions as relevant to reduce noise in the issue description.*
11+
12+
## Overview
13+
14+
*Written as a user story*.
15+
16+
**As a** <user>, **I want** <thing>, **So I can** <action>.
17+
18+
## Description
19+
20+
*Add the finer details of what this task involves and is trying to accomplish. A problem well defined is half-solved*.
21+
22+
## Acceptance criteria
23+
24+
*Add any exacting acceptance criteria for the task to be complete. Start with known hard requirements, since they may create blockers.*

‎.github/ISSUE_TEMPLATE/4-epic_overview.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Epic overview
3+
about: This template is for planning an epic, which is a large body of effort involving multiple stories or tasks
4+
title: ""
5+
labels: "epic, documentation"
6+
projects: ["nginxinc/32"]
7+
assignees: ""
8+
---
9+
10+
*Remove italicized directions as relevant to reduce noise in the issue description.*
11+
12+
## Description
13+
14+
*Write a high-level description of what the body of work for this epic includes.*
15+
16+
## Goals
17+
18+
*Describe the intent of the epic and what the intended impact is for this effort.*
19+
20+
## User stories
21+
22+
*Add a user story for relevant persona to this epic, who are the stakeholders*.
23+
24+
**As a** <user>,
25+
**I want** <thing>,
26+
**So I can** <action>.
27+
28+
**As a** <user>,
29+
**I want** <thing>,
30+
**So I can** <action>.
31+
32+
## Tasks
33+
34+
*Create a simple list of tasks necessary for this epic. Finer details should be kept to sub-issues/tasks/stories.*
35+
36+
- Example task 1
37+
- Example task 1
38+
- Example task 1
39+
- Example task 1
40+
- Example task 1

‎.github/ISSUE_TEMPLATE/5-content_plan.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Content release plan
3+
about: This template is for a content release plan, typically tied to a product release
4+
title: " v#.# content release plan"
5+
labels: "documentation"
6+
projects: ["nginxinc/32"]
7+
assignees: ""
8+
---
9+
10+
*Remove italicized directions as relevant to reduce noise in the issue description.*
11+
12+
## Overview
13+
14+
- **Product name**:
15+
- **Release date**:
16+
17+
A content release plan establishes and tracks the documentation work for a product related to a release.
18+
19+
Add tickets to this content release plan as sub-issues, and update it as you go along.
20+
21+
## Description
22+
23+
*Write a high-level summary of changes expected in this release*.
24+
25+
## User stories
26+
27+
**As a** technical writer,
28+
**I want** a content release plan for my product,
29+
**So I can** ensure correct content is released alongside the latest version of the product.
30+
31+
**As a** product owner,
32+
**I want** a content release plan for my product,
33+
**So I can** ensure the product team includes documentation as part of changes to the product.
34+
35+
## Tasks
36+
37+
*Create a simple list of tasks necessary for this content plan. Finer details can be kept to sub-issues.*
38+
*Each task item should have a 1:1 relationship with a documentation item, which could be an engineering issue.*
39+
40+
- [ ] Update changelog/release notes
41+
- [ ] Update version reference information (Such as technical specifications, version shortcodes)
42+
- [ ] Update any other documentation impacted by changes in this release
43+
- Additional task 1
44+
- Additional task 2

‎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.

‎content/agent/_index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "NGINX Agent"
3-
description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance."
4-
linkTitle: "NGINX Agent"
5-
menu: docs
2+
title: NGINX Agent
3+
description: NGINX Agent is a companion daemon for your NGINX Open Source or NGINX
4+
Plus instance.
65
url: /nginx-agent/
76
cascade:
8-
logo: "NGINX-product-icon.png"
9-
---
7+
logo: NGINX-product-icon.png
8+
---

‎content/agent/configuration/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: "Configuration"
3-
description: "Learn how to configure NGINX Agent."
4-
linkTitle: "Configuration"
5-
weight: "400"
6-
menu: docs
2+
title: Configuration
3+
description: Learn how to configure NGINX Agent.
4+
weight: 400
75
url: /nginx-agent/configuration/
8-
---
6+
---

‎content/agent/configuration/configuration-overview.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Basic configuration"
2+
title: Basic configuration
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1229"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1229
7+
type:
8+
- how-to
109
---
1110

1211
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.

‎content/agent/configuration/configure-nginx-agent-features.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: "Features configuration"
2+
title: Features configuration
33
draft: false
44
weight: 150
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
6+
type:
7+
- how-to
98
---
109

1110
## Overview

‎content/agent/configuration/configure-nginx-agent-group.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
2-
title: "Add NGINX users to nginx-agent Group"
2+
title: Add NGINX users to nginx-agent Group
33
draft: false
44
weight: 300
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-933"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-933
7+
type:
8+
- how-to
109
---
1110

1211
## Overview
1312

1413
During installation, NGINX Agent detects the NGINX user (typically `nginx`) for the master and worker processes and adds this user to a group called `nginx-agent`.
1514

16-
If you change the NGINX username after installing the NGINX Agent, you'll need to add the new username to the `nginx-agent` group so that the NGINX socket has the proper permissions.
15+
If you change the NGINX username after installing NGINX Agent, you'll need to add the new username to the `nginx-agent` group so that the NGINX socket has the proper permissions.
1716

1817
A failure to update the `nginx-agent` group when the NGINX username changes may result in non-compliance errors for NGINX Plus.
1918

‎content/agent/configuration/encrypt-communication.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
title: Encrypt communication
3-
tags:
4-
- docs
53
toc: true
64
weight: 200
7-
docs: "DOCS-802"
5+
docs: DOCS-802
86
---
97

108
## Overview

‎content/agent/configuration/health-checks.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: "Health checks"
2+
title: Health checks
33
draft: false
44
weight: 400
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
6+
type:
7+
- how-to
98
---
109

1110
## Overview

‎content/agent/contribute/_index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
title: "Contribute"
3-
description: "Learn about the NGINX Agent community and contribute to the project."
4-
linkTitle: "Contribute"
5-
menu: docs
6-
weight: "500"
2+
title: Contribute
3+
description: Learn about the NGINX Agent community and contribute to the project.
4+
weight: 500
75
url: /nginx-agent/contribute/
8-
---
6+
---

‎content/agent/contribute/community.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Community and contribution"
2+
title: Community and contribution
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1087"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1087
7+
type:
8+
- how-to
109
---
1110

1211
# Community

‎content/agent/contribute/dev-environment-setup.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Development environment setup"
2+
title: Development environment setup
33
draft: false
44
weight: 200
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1088"
8-
categories: ["development"]
9-
doctypes: ["task"]
6+
docs: DOCS-1088
7+
type:
8+
- how-to
109
---
1110

1211
## Overview

‎content/agent/installation-upgrade/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Installation and upgrade"
3-
description: "Learn how to install, upgrade, and uninstall NGINX Agent."
4-
menu: docs
2+
title: Installation and upgrade
3+
description: Learn how to install, upgrade, and uninstall NGINX Agent.
54
weight: 300
65
url: /nginx-agent/installation-upgrade/
7-
---
6+
---

‎content/agent/installation-upgrade/container-environments/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
title: "Container environments"
3-
description: "Learn how to build and run NGINX Agent docker images."
4-
menu: docs
2+
title: Container environments
3+
description: Learn how to build and run NGINX Agent docker images.
54
weight: 800
65
ur: /nginx-agent/installation-upgrade/container-environments/
7-
---
6+
---

‎content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Build container images"
2+
title: Build container images
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
categories: ["configuration"]
8-
doctypes: ["task"]
9-
docs: "DOCS-1410"
6+
docs: DOCS-1410
7+
type:
8+
- how-to
109
---
1110

1211
## Overview

‎content/agent/installation-upgrade/container-environments/docker-support.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
22
title: Container support and troubleshooting
3-
categories:
4-
- installation
53
draft: false
6-
tags:
7-
- docs
84
toc: true
95
weight: 200
10-
docs: "DOCS-909"
6+
docs: DOCS-909
7+
type:
8+
- task
119
---
1210

1311
## Overview

‎content/agent/installation-upgrade/getting-started.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Getting started"
2+
title: Getting started
33
draft: false
44
weight: 100
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1089"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1089
7+
type:
8+
- how-to
109
---
1110

1211
## Overview

‎content/agent/installation-upgrade/installation-github.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: "Installation from GitHub release"
2+
title: Installation from GitHub release
33
draft: false
44
weight: 200
55
toc: true
6-
tags: [ "docs" ]
7-
docs: "DOCS-1090"
8-
categories: ["configuration"]
9-
doctypes: ["task"]
6+
docs: DOCS-1090
7+
type:
8+
- how-to
109
---
1110

1211
## Overview

0 commit comments

Comments
 (0)