Skip to content

Commit 244c403

Browse files
ADubhlaoichtravisamartinJTorreG
authored
feat: Update issue templates & process docs (#1287)
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. --------- Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com> Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
1 parent 07072ed commit 244c403

16 files changed

+322
-183
lines changed

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

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/1-idea_suggestion.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Documentation idea
2+
description: Suggest an idea for improving documentation
3+
title: "[Idea]: "
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: What is your idea for improving documentation?
8+
description: Describe your idea with as much information as possible.
9+
validations:
10+
required: true
11+
- type: dropdown
12+
attributes:
13+
label: Which product or products does this request relate to?
14+
multiple: true
15+
options:
16+
- F5 DoS for NGINX
17+
- F5 WAF for NGINX
18+
- NGINX Agent
19+
- NGINXaaS for Azure
20+
- NGINXaaS for Google Cloud
21+
- NGINX Gateway Fabric
22+
- NGINX Ingress Controller
23+
- NGINX Instance Manager
24+
- NGINX One Console
25+
- NGINX Plus
26+
- Other
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Is this idea related to a larger problem?
32+
description: If you have identified multiple related issues, it might be a design pattern problem.
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: What alternative ways are there to implement your idea?
38+
description: There are often multiple ways to something - context is important.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Any additional information
44+
description: Add any remaining detail for this idea not covered by the above questions.

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

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/2-bug_report.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug report
2+
description: Report an issue with our documentation
3+
title: "[Bug]: "
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Describe the bug you have identified
8+
description: Explain the problem with as much detail as possible.
9+
validations:
10+
required: true
11+
- type: dropdown
12+
attributes:
13+
label: Which product or products does this request relate to?
14+
multiple: true
15+
options:
16+
- F5 DoS for NGINX
17+
- F5 WAF for NGINX
18+
- NGINX Agent
19+
- NGINXaaS for Azure
20+
- NGINXaaS for Google Cloud
21+
- NGINX Gateway Fabric
22+
- NGINX Ingress Controller
23+
- NGINX Instance Manager
24+
- NGINX One Console
25+
- NGINX Plus
26+
- Other
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Steps to reproduce the bug
32+
description: Describe the where the issue occurs.
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: What is the expected or desired behaviour?
38+
description: Describe what you expected to happen instead of the bug.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: What environments or versions does this bug affect?
44+
description: Describe the contexts which this bug seems to occur.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Any additional information
50+
description: Add any remaining detail for this idea not covered by the above questions.

‎.github/ISSUE_TEMPLATE/3-general_request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: General request
2+
description: Make a general documentation request.
3+
title: "[Request]: "
4+
body:
5+
- type: textarea
6+
attributes:
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+
validations:
10+
required: true
11+
- type: dropdown
12+
attributes:
13+
label: Which product or products does this request relate to?
14+
multiple: true
15+
options:
16+
- F5 DoS for NGINX
17+
- F5 WAF for NGINX
18+
- NGINX Agent
19+
- NGINXaaS for Azure
20+
- NGINXaaS for Google Cloud
21+
- NGINX Gateway Fabric
22+
- NGINX Ingress Controller
23+
- NGINX Instance Manager
24+
- NGINX One Console
25+
- NGINX Plus
26+
- Other
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Who is the person directly responsible for initiating this request?
32+
description: Name the specific person that made this request.
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Is this request part of a larger initiative or project?
38+
description: If it is, name the project the request relates to.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Are there important constraints for this request?
44+
description: If the constraints are particularly complex, you may wish to organise a meeting before filing a request.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Does this request have a due date?
50+
description: You should name any specific date or milestones (Such as "Q3") you have in mind for this request, and any dependencies or blockers affecting it.
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Any additional information
56+
description: Add any remaining detail for this request not covered by the above questions.

‎.github/ISSUE_TEMPLATE/3-story_task.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/4-epic_overview.md‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/4-story_task.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: User story
2+
description: This template is for a single story, encompassing a single work item for completion
3+
title: "[Story]: "
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Overview
8+
description: Use this section to write user stories.
9+
placeholder: As a user, I want thing, So I can action.
10+
validations:
11+
required: true
12+
- type: dropdown
13+
attributes:
14+
label: Which product or products does this request relate to?
15+
multiple: true
16+
options:
17+
- F5 DoS for NGINX
18+
- F5 WAF for NGINX
19+
- NGINX Agent
20+
- NGINXaaS for Azure
21+
- NGINXaaS for Google Cloud
22+
- NGINX Gateway Fabric
23+
- NGINX Ingress Controller
24+
- NGINX Instance Manager
25+
- NGINX One Console
26+
- NGINX Plus
27+
- Other
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Description
33+
description: Add the finer details of what this task involves and is trying to accomplish.
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Acceptance criteria
39+
description: Acceptance criteria are written from a user perspective, and should map to the user stories.
40+
validations:
41+
required: true

‎.github/ISSUE_TEMPLATE/5-content_plan.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)