Skip to content

Commit c888768

Browse files
committed
feat: Update issue templates & process docs
This commit updates the issue templates into the repository, converting them from plain Markdown templates to interactive forms. It also updates the process documentation, re-organising them into topic groups and adding guidance on the level of desired detail for requests.
1 parent 18bed07 commit c888768

File tree

11 files changed

+87
-8
lines changed

11 files changed

+87
-8
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: General request
3+
about: This template is for recording general documentation requests
4+
title: ""
5+
labels: "enhancement"
6+
projects: ["nginx/22"]
7+
assignees: ""
8+
---
9+
10+
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
11+
12+
*Remove italicized directions as relevant to reduce noise in the issue description.*
13+
14+
### What would you like the documentation team to work on?
15+
16+
*Please describe your request with as much detail as possible.*
17+
18+
### Who is the person directly responsible for initiating this request?
19+
20+
*Name the specific stakeholders for this request.*
21+
22+
### Is this request part of a larger initiative or project?
23+
24+
*Mention the project related to the broader impact this request relates to.*
25+
26+
### Is there important information necessary to contextualise this request?
27+
28+
*If the request is particularly large, you may want to organise a meeting before filing an issue.*
29+
30+
### Does this request have a due date?
31+
32+
*You should name any specific date you have in mind for this request, or any dependencies/blockers that would determine it.*
33+
34+
### Any additional information
35+
36+
*Add any remaining detail for this request not covered by the above questions.*
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: General request
2+
description: Make a general documentation request.
3+
title: "[Request]: "
4+
body:
5+
- type: textarea
6+
id: what-work
7+
label: What would you like the documentation team to work on?
8+
description: Please describe your request with as much detail as possible.
9+
- type: dropdown
10+
id: what-product
11+
label: Which product or products does this relate to?
12+
description: You can figure this out based on page URL
13+
multiple: true
14+
options:
15+
- F5 DoS for NGINX
16+
- F5 WAF for NGINX
17+
- NGINX Agent
18+
- NGINXaaS for Azure
19+
- NGINX Gateway Fabric
20+
- NGINX Ingress Controller
21+
- NGINX Instance Manager
22+
- NGINX One Console
23+
- NGINX Plus
24+
- Other
25+
- type: textarea
26+
id: direct-responsibility
27+
label: Who is the person directly responsible for initiating this request?
28+
description: Name the specific person that made this request.
29+
- type: textarea
30+
id: request-scope
31+
label: Is this request part of a larger initiative or project?
32+
description: If it is, name the project the request relates to
33+
- type: textarea
34+
id: request-constraints
35+
label: Are there important constraints for this request?
36+
description: If the constraints are particularly complex, you may wish to organise a meeting instead of filing a request
37+
- type: textarea
38+
id: request-deadline
39+
label: Does this request have a due date?
40+
description: You should name any specific date you have in mind for this request, or any dependencies/blockers that would determine it.
41+
- type: textarea
42+
id: additional-information
43+
label: Any additional information
44+
description: Add any remaining detail for this request not covered by the above questions.
File renamed without changes.

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ If you'd like to discuss something NGINX-related that doesn't involve documentat
3434

3535
## Submit a pull request
3636

37-
Before making documentation changes, you should view the [documentation style guide](/documentation/style-guide.md) and [Managing content with Hugo](/documentation/writing-hugo.md).
37+
Before making documentation changes, you should view the [documentation style guide](/documentation/style-guide.md) and [Managing content with Hugo](/documentation/hugo-content.md).
3838

3939
To understand how we use Git in this repository, read our [Git conventions](/documentation/git-conventions.md) documentation.
4040

4141
The broad workflow is as follows:
4242

4343
- Fork the NGINX repository
44-
- If you're an F5/NGINX user, you can work from a clone
44+
- If you're an F5/NGINX user, you can branch directly with a clone
4545
- Create a branch
4646
- Implement your changes in your branch
4747
- Submit a pull request (PR) when your changes are ready for review
@@ -53,10 +53,9 @@ Alternatively, you're welcome to suggest improvements to highlight problems with
5353
To ensure a balance between work carried out by the NGINX team while encouraging community involvement on this project, we use the following
5454
issue lifecycle:
5555

56-
- A new issue is created by a community member
57-
- An owner on the NGINX team is assigned to the issue; this owner shepherds the issue through the subsequent stages in the issue lifecycle
58-
- The owner assigns one or more [labels](https://github.com/nginxinc/oss-docs/issues/labels) to the issue
59-
- The owner, in collaboration with the community member, determines what milestone to attach to an issue. They may be milestones correspond to product releases
56+
- A new issue is created by
57+
- A maintainer from the F5 team is assigned to the issue; this maintainer shepherds the issue through the subsequent stages in the issue lifecycle
58+
- The maintainer assigns one or more [labels](https://github.com/nginx/documentation/labels) to the issue
6059

6160
## Additional NGINX documentation
6261

documentation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you're interested in contributing to the [NGINX documentation website](https:
1616
- [Git conventions](/documentation/git-conventions.md)
1717
- [Information architecture heuristics](/documentation/ia-heuristics.md)
1818
- [Maintainers etiquette](/documentation/maintainers-etiquette.md)
19-
- [Managing content with Hugo](/documentation/writing-hugo.md)
19+
- [Managing content with Hugo](/documentation/hugo-content.md)
2020
- [Proposals](/documentation/proposals/README.md)
2121
- [Set up pre-commit](/documentation/pre-commit.md)
2222
- [Using include files](/documentation/include-files.md)
File renamed without changes.

0 commit comments

Comments
 (0)