Skip to content

Commit 122f08c

Browse files
authored
Merge branch 'main' into unit-docs
2 parents 9589aa9 + 3c3c1b5 commit 122f08c

File tree

661 files changed

+3843
-2922
lines changed

Some content is hidden

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

661 files changed

+3843
-2922
lines changed
File renamed without changes.
File renamed without changes.
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.*
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
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

.github/workflows/fossa.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ jobs:
2525
uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
2626

2727
- name: Scan
28-
uses: fossas/fossa-action@93a52ecf7c3ac7eb40f5de77fd69b1a19524de94 # v1.5.0
28+
uses: fossas/fossa-action@c0a7d013f84c8ee5e910593186598625513cc1e4 # v1.6.0
2929
with:
3030
api-key: ${{ secrets.FOSSA_TOKEN }}

.github/workflows/ossf_scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ jobs:
5656

5757
# Upload the results to GitHub's code scanning dashboard.
5858
- name: Upload SARIF results to code scanning
59-
uses: github/codeql-action/upload-sarif@6bb031afdd8eb862ea3fc1848194185e076637e5 # v3.28.11
59+
uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
6060
with:
6161
sarif_file: results.sarif

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

0 commit comments

Comments
 (0)