Skip to content

Commit 79c5a3d

Browse files
ADubhlaoichADubhlaoich
authored
Merge branch 'main' into fix-add-screenshot-certs
2 parents 58ea244 + 3c76f43 commit 79c5a3d

File tree

895 files changed

+14733
-11198
lines changed

Some content is hidden

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

895 files changed

+14733
-11198
lines changed

‎.cloudcannon/initial-site-settings.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"ssg": "hugo",
3+
"mode": "hosted",
4+
"build": {
5+
"install_command": "[ -f package.json ] && npm i",
6+
"build_command": "hugo --destination public --baseURL / --noTimes",
7+
"output_path": "public",
8+
"environment_variables": [
9+
{
10+
"key": "HUGO_CACHEDIR",
11+
"value": "/usr/local/__site/src/.hugo_cache/"
12+
}
13+
],
14+
"preserved_paths": "node_modules/,.hugo_cache/,resources/",
15+
"preserve_output": false,
16+
"include_git": true,
17+
"manually_configure_urls": false,
18+
"hugo_version": "0.134.3",
19+
"ruby_version": "2.7.3",
20+
"node_version": "18",
21+
"deno_version": "1.40.2"
22+
}
23+
}

‎.cloudcannon/schemas/nms/policy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Confirm the policy is being enforced:
153153

154154
<!-- Add troubleshooting steps for issues users might encounter and can self-solve. The purpose of this section is to deflect customer calls to Support. -->
155155

156-
For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< relref "support/contact-support.md" >}}) for assistance.
156+
For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< ref "support/contact-support.md" >}}) for assistance.
157157

158158
### Issue 1
159159

‎.gitattributes‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Set the default behavior for correcting line endings,
22
# in case people don't have core.autocrlf set.
33
* text=auto
4-
4+
.github/workflows/update_from_nginx_documentation.yml merge=ours
5+
.gitattributes merge=ours

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ content/nap-waf/* @nginx/nap-docs-approvers
3030
data/nap-waf/* @nginx/nap-docs-approvers
3131

3232
# NGINXaaS for Azure
33-
content/nginxaas-azure/* @nginx/n4a-docs
34-
content/includes/nginxaas-azure/* @nginx/n4a-docs
33+
content/nginxaas-azure/* @nginx/n4a-docs-approvers
34+
content/includes/nginxaas-azure/* @nginx/n4a-docs-approvers
3535

3636
# NGINX Gateway Fabric
3737
content/ngf/* @nginx/nginx-gateway-fabric

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

‎.github/labeler.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Label PRs based on modified file paths (v5 format)
2+
# https://github.com/actions/labeler
3+
4+
# General documentation
5+
6+
documentation:
7+
- changed-files:
8+
- any-glob-to-any-file:
9+
- 'content/**'
10+
- 'assets/**'
11+
- 'static/**'
12+
- 'data/**'
13+
14+
# Product labels
15+
16+
product/agent:
17+
- changed-files:
18+
- any-glob-to-any-file:
19+
- 'content/agent/**'
20+
- 'content/includes/agent/**'
21+
22+
product/amplify:
23+
- changed-files:
24+
- any-glob-to-any-file: 'content/amplify/**'
25+
26+
product/controller:
27+
- changed-files:
28+
- any-glob-to-any-file:
29+
- 'content/controller/**'
30+
- 'content/includes/controller/**'
31+
32+
product/mesh:
33+
- changed-files:
34+
- any-glob-to-any-file: 'content/mesh/**'
35+
36+
product/modsec-waf:
37+
- changed-files:
38+
- any-glob-to-any-file: 'content/modsec-waf/**'
39+
40+
product/nap-dos:
41+
- changed-files:
42+
- any-glob-to-any-file:
43+
- 'content/nap-dos/**'
44+
- 'content/includes/nap-dos/**'
45+
46+
product/nap-waf:
47+
- changed-files:
48+
- any-glob-to-any-file:
49+
- 'content/nap-waf/**'
50+
- 'content/includes/nap-waf/**'
51+
52+
product/ngf:
53+
- changed-files:
54+
- any-glob-to-any-file:
55+
- 'content/ngf/**'
56+
- 'content/includes/ngf/**'
57+
58+
product/nginx-plus:
59+
- changed-files:
60+
- any-glob-to-any-file:
61+
- 'content/nginx/**'
62+
- 'content/includes/nginx-plus/**'
63+
64+
product/nginx-one:
65+
- changed-files:
66+
- any-glob-to-any-file:
67+
- 'content/nginx-one/**'
68+
- 'content/includes/nginx-one/**'
69+
70+
product/nginxaas:
71+
- changed-files:
72+
- any-glob-to-any-file:
73+
- 'content/nginxaas-azure/**'
74+
- 'content/includes/nginxaas-azure/**'
75+
76+
product/nim:
77+
- changed-files:
78+
- any-glob-to-any-file:
79+
- 'content/nim/**'
80+
- 'content/includes/nim/**'
81+
82+
product/nms:
83+
- changed-files:
84+
- any-glob-to-any-file:
85+
- 'content/nms/**'
86+
- 'content/includes/nms/**'
87+
88+
product/unit:
89+
- changed-files:
90+
- any-glob-to-any-file:
91+
- 'content/unit/**'
92+
- 'content/includes/unit/**'
93+
94+
# Other labels
95+
96+
process documentation:
97+
- changed-files:
98+
- any-glob-to-any-file:
99+
- 'templates/**'
100+
- '*.md'
101+
- 'LICENSE'
102+
103+
tooling:
104+
- changed-files:
105+
- any-glob-to-any-file:
106+
- 'layouts/**'
107+
- '.github/**'
108+
- '.cloudcannon/**'
109+
- 'styles/**'
110+
- 'layouts/**'
111+
- 'config/**'
112+
- 'archetypes/**'
113+
- '*.yml'
114+
- '*.yaml'
115+
- '*.json'
116+
- '*.ts'
117+
- '*.sh'
118+
- '*.js'
119+
- 'Makefile'
120+
- '.vale.ini'
121+
- '.gitignore'
122+
- '.gitattributes'

0 commit comments

Comments
 (0)