Skip to content

Commit 55ef924

Browse files
authored
feat: Update process documentation, issue templates (#1409)
This commit adds NGINX Unit to the deprecated content process document, and updates the issue templates to reduce the amount of mandatory fields and rephrase questions to be more open-ended in the bug report and idea forms, accounting for simpler issues. It also removes some leftover include files related to products whose main content folders have already been removed.
1 parent 80ba757 commit 55ef924

34 files changed

+13
-489
lines changed

.github/ISSUE_TEMPLATE/1-idea_suggestion.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
required: true
1111
- type: dropdown
1212
attributes:
13-
label: Which product or products does this request relate to?
13+
label: Which product or products does this idea relate to?
1414
multiple: true
1515
options:
1616
- F5 DoS for NGINX
@@ -28,16 +28,12 @@ body:
2828
required: true
2929
- type: textarea
3030
attributes:
31-
label: Is this idea related to a larger problem?
31+
label: Does this idea relate to other issues?
3232
description: If you have identified multiple related issues, it might be a design pattern problem.
33-
validations:
34-
required: true
3533
- type: textarea
3634
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
35+
label: Are there alternative ideas for improving the same topic?
36+
description: If you already identified reasons not to go with other solutions, we'd like to know why!
4137
- type: textarea
4238
attributes:
4339
label: Any additional information

.github/ISSUE_TEMPLATE/2-bug_report.yml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
name: Bug report
2-
description: Report an issue with our documentation
2+
description: Report an issue with our content or website
33
title: "[Bug]: "
44
body:
55
- type: textarea
66
attributes:
7-
label: Describe the bug you have identified
7+
label: Describe the problem you have identified
88
description: Explain the problem with as much detail as possible.
99
validations:
1010
required: true
1111
- type: dropdown
1212
attributes:
13-
label: Which product or products does this request relate to?
13+
label: Which product or products does this problem relate to?
1414
multiple: true
1515
options:
1616
- F5 DoS for NGINX
@@ -28,22 +28,16 @@ body:
2828
required: true
2929
- type: textarea
3030
attributes:
31-
label: Steps to reproduce the bug
31+
label: If necessary, explain any additional steps to reproduce the problem.
3232
description: Describe the where the issue occurs.
33-
validations:
34-
required: true
3533
- type: textarea
3634
attributes:
3735
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
36+
description: Describe what you expected to happen instead of the problem
4137
- type: textarea
4238
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
39+
label: Is this problem specific to a particular platform or software version?
40+
description: Describe the context in which this problem appears.
4741
- type: textarea
4842
attributes:
4943
label: Any additional information

content/includes/acm/about/api-proxy-policies.md

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

content/includes/acm/about/global-policies.md

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

content/includes/acm/how-to/access-acm-api.md

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

content/includes/acm/how-to/access-acm-ui.md

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

content/includes/acm/how-to/policies-intro.md

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

content/includes/acm/how-to/policies-proxy-cluster-intro.md

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

content/includes/acm/how-to/policies-proxy-intro.md

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

content/includes/acm/how-to/policies/api-owner-persona.md

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

0 commit comments

Comments
 (0)