Skip to content

Commit 67d48dc

Browse files
authored
feat: Update issue and overview process documentation (#1446)
This commit re-orders the issue templates, adds examples of issues and guidance on what templates should be used. It also adds a reference to the nginx.org content pipeline documentation that was stored in the folder but not linked from the newer index.
1 parent f7308bf commit 67d48dc

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

documentation/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ If you're interested in contributing to the [NGINX documentation website](https:
1919
- [Using include files](/documentation/include-files.md)
2020
- [Contributing closed content](/documentation/closed-contributions.md)
2121
- [Review deprecated content](/documentation/deprecated-content.md)
22+
- [nginx.org content](/documentation/nginx-org-source.md)
2223

2324
## Writing guidance
2425

documentation/prepare-issue.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ We strive to make each issue a single source of truth: as a result, each ticket
66

77
This document exists to explain concepts you may be unfamiliar with, and provide examples of the types and amount of detail preferred.
88

9+
Here are examples of well-formed issues using the templates:
10+
11+
- [\[Request\]: Clarify NGINX configuration limitations for F5 WAF for NGINX](https://github.com/nginx/documentation/issues/1436)
12+
- [\[Story\]: Replace examples of sensitive values with explicit placeholders](https://github.com/nginx/documentation/issues/1363)
13+
14+
*General request* and *Bug report* are the most common issue types, with *Documentation idea* available for conceptual improvements.
15+
16+
The *User story* and *Content release plans* are largely for maintainer use, though we do have [guidance for user stories](#user-stories-and-acceptance-criteria) in this document.
17+
918
## Use active voice
1019

1120
Much like writing user-facing documentation, we prefer [active voice](https://developers.google.com/tech-writing/one/active-voice) when describing an issue.

0 commit comments

Comments
 (0)