Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c888768
feat: Update issue templates & process docs
ADubhlaoich Oct 10, 2025
76e23f5
fix: Incorrect attribute nesting
ADubhlaoich Oct 10, 2025
986fb6f
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich Oct 10, 2025
4861041
fix: test
ADubhlaoich Oct 10, 2025
dfc0094
feat: Unhide other sections
ADubhlaoich Oct 10, 2025
50dbb09
fix: Remove unnecessary IDs, nest last item
ADubhlaoich Oct 10, 2025
34a70d8
feat: Rename existing templates, update first
ADubhlaoich Oct 10, 2025
88a67c5
fix: Syntax error caused by colon
ADubhlaoich Oct 10, 2025
30c3b10
fix: Remove unnecessary lines
ADubhlaoich Oct 10, 2025
f36097e
fix: Needless nesting
ADubhlaoich Oct 10, 2025
84473dc
feat: Update templates
ADubhlaoich Oct 10, 2025
6dea358
feat: Finish converting issue templates to forms
ADubhlaoich Oct 10, 2025
b1bb124
fix: Template issues
ADubhlaoich Oct 10, 2025
fd350bf
fix: Attempt to fix template
ADubhlaoich Oct 10, 2025
b0f0bbc
fix: Update story task template
ADubhlaoich Oct 10, 2025
7e2ca49
feat: Add preparing issue documentation
ADubhlaoich Oct 10, 2025
d5c544e
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich Oct 10, 2025
7dd4541
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich Oct 13, 2025
cffdd81
Update documentation/prepare-issue.md
ADubhlaoich Oct 13, 2025
a72f8fc
Update documentation/prepare-issue.md
ADubhlaoich Oct 13, 2025
73fa3a3
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich Oct 13, 2025
f868a73
feat: Restructure doc, add note on active voice
ADubhlaoich Oct 13, 2025
570548e
Apply suggestions from code review
ADubhlaoich Oct 13, 2025
83ea754
Merge branch 'main' into docs/request-template-guidance
ADubhlaoich Oct 14, 2025
3804c49
Apply suggestions from code review
ADubhlaoich Oct 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/1-feature_request.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/1-idea_suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Documentation idea
description: Suggest an idea for improving documentation
title: "[Idea]: "
body:
- type: textarea
attributes:
label: What is your idea for improving documentation?
description: Describe your idea with as much information as possible.
validations:
required: true
- type: dropdown
attributes:
label: Which product or products does this request relate to?
multiple: true
options:
- F5 DoS for NGINX
- F5 WAF for NGINX
- NGINX Agent
- NGINXaaS for Azure
- NGINXaaS for Google Cloud
- NGINX Gateway Fabric
- NGINX Ingress Controller
- NGINX Instance Manager
- NGINX One Console
- NGINX Plus
- Other
validations:
required: true
- type: textarea
attributes:
label: Is this idea related to a larger problem?
description: If you have identified multiple related issues, it might be a design pattern problem.
validations:
required: true
- type: textarea
attributes:
label: What alternative ways are there to implement your idea?
description: There are often multiple ways to something - context is important.
validations:
required: true
- type: textarea
attributes:
label: Any additional information
description: Add any remaining detail for this idea not covered by the above questions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/2-bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug report
description: Report an issue with our documentation
title: "[Bug]: "
body:
- type: textarea
attributes:
label: Describe the bug you have identified
description: Explain the problem with as much detail as possible.
validations:
required: true
- type: dropdown
attributes:
label: Which product or products does this request relate to?
multiple: true
options:
- F5 DoS for NGINX
- F5 WAF for NGINX
- NGINX Agent
- NGINXaaS for Azure
- NGINXaaS for Google Cloud
- NGINX Gateway Fabric
- NGINX Ingress Controller
- NGINX Instance Manager
- NGINX One Console
- NGINX Plus
- Other
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce the bug
description: Describe the where the issue occurs.
validations:
required: true
- type: textarea
attributes:
label: What is the expected or desired behaviour?
description: Describe what you expected to happen instead of the bug.
validations:
required: true
- type: textarea
attributes:
label: What environments or versions does this bug affect?
description: Describe the contexts which this bug seems to occur.
validations:
required: true
- type: textarea
attributes:
label: Any additional information
description: Add any remaining detail for this idea not covered by the above questions.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/3-general_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: General request
description: Make a general documentation request.
title: "[Request]: "
body:
- type: textarea
attributes:
label: What would you like the documentation team to work on?
description: Please describe your request with as much detail as possible.
validations:
required: true
- type: dropdown
attributes:
label: Which product or products does this request relate to?
multiple: true
options:
- F5 DoS for NGINX
- F5 WAF for NGINX
- NGINX Agent
- NGINXaaS for Azure
- NGINXaaS for Google Cloud
- NGINX Gateway Fabric
- NGINX Ingress Controller
- NGINX Instance Manager
- NGINX One Console
- NGINX Plus
- Other
validations:
required: true
- type: textarea
attributes:
label: Who is the person directly responsible for initiating this request?
description: Name the specific person that made this request.
validations:
required: true
- type: textarea
attributes:
label: Is this request part of a larger initiative or project?
description: If it is, name the project the request relates to.
validations:
required: true
- type: textarea
attributes:
label: Are there important constraints for this request?
description: If the constraints are particularly complex, you may wish to organise a meeting before filing a request.
validations:
required: true
- type: textarea
attributes:
label: Does this request have a due date?
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.
validations:
required: true
- type: textarea
attributes:
label: Any additional information
description: Add any remaining detail for this request not covered by the above questions.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/3-story_task.md

This file was deleted.

40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/4-epic_overview.md

This file was deleted.

41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/4-story_task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: User story
description: This template is for a single story, encompassing a single work item for completion
title: "[Story]: "
body:
- type: textarea
attributes:
label: Overview
description: Use this section to write user stories.
placeholder: As a user, I want thing, So I can action.
validations:
required: true
- type: dropdown
attributes:
label: Which product or products does this request relate to?
multiple: true
options:
- F5 DoS for NGINX
- F5 WAF for NGINX
- NGINX Agent
- NGINXaaS for Azure
- NGINXaaS for Google Cloud
- NGINX Gateway Fabric
- NGINX Ingress Controller
- NGINX Instance Manager
- NGINX One Console
- NGINX Plus
- Other
validations:
required: true
- type: textarea
attributes:
label: Description
description: Add the finer details of what this task involves and is trying to accomplish.
validations:
required: true
- type: textarea
attributes:
label: Acceptance criteria
description: Acceptance criteria are written from a user perspective, and should map to the user stories.
validations:
required: true
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/5-content_plan.md

This file was deleted.

Loading