Skip to content

Commit 0d52d19

Browse files
zuchkazuchka
authored
GH Issues: replace markdown-based Bug Report form w/ YAML-based form (grafana#67244)
* replaces markdown report w yaml * switch to opentext + feedback changes
1 parent 01aa776 commit 0d52d19

File tree

3 files changed

+182
-31
lines changed

3 files changed

+182
-31
lines changed

‎.github/ISSUE_TEMPLATE/0-bug-report.yaml

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
name: New Bug Report
2+
description: File a bug report
3+
title: "Product-Area-Here: short description of bug here"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
10+
Please try to give your issue a good title. Try using the product-area where you are having an issue and a brief description of the problem. Like this:
11+
- `Dashboards: Template Variables break when I do X` or
12+
- `Alerting: message templating plus Slack channel breaks when I do X`
13+
- type: markdown
14+
attributes:
15+
value: |
16+
**HINT:** Have you tried [searching](https://github.com/grafana/grafana/issues) for similar issues? Duplicate issues are common.
17+
18+
**Are you reporting a security vulnerability?** [Submit it here instead](https://github.com/grafana/grafana/security/policy).
19+
- type: markdown
20+
attributes:
21+
value: |
22+
#
23+
- type: textarea
24+
id: bug-describe
25+
attributes:
26+
label: |
27+
28+
# What went wrong?
29+
30+
description: |
31+
#
32+
Describe your bug. What happened? What did you expect to happen?
33+
34+
**Hot Tip:** Record your screen and add it here as a gif.
35+
placeholder: Tell us what you see!
36+
value: |
37+
**What happened**:
38+
39+
-
40+
41+
**What did you expect to happen**:
42+
43+
-
44+
45+
validations:
46+
required: true
47+
- type: markdown
48+
attributes:
49+
value: |
50+
#
51+
- type: textarea
52+
id: bug-repro
53+
attributes:
54+
label: |
55+
56+
# How do we reproduce it?
57+
58+
description: |
59+
#
60+
61+
Whenever possible, please provide **detailed** steps for reproducing your bug.
62+
63+
**This is very helpful info**
64+
placeholder: "Step 1:..."
65+
value: |
66+
**Step 1**:
67+
68+
- Open Grafana and do X
69+
70+
**Step 2**:
71+
72+
- Now click button Y
73+
74+
**Step 3**:
75+
76+
- Wait for the browser to crash. Error message says: "Error..."
77+
validations:
78+
required: true
79+
- type: markdown
80+
attributes:
81+
value: |
82+
#
83+
- type: input
84+
id: gf-version
85+
attributes:
86+
label: |
87+
88+
# What Grafana version are you using?
89+
90+
description: |
91+
#
92+
- [How do I find my Grafana version info?](https://community.grafana.com/t/how-to-find-your-grafana-version-info-3-different-ways/86857)
93+
placeholder: "ex: v9.5.0, or v9.5.0-cloud.5.a016665c (b2a5d45589)"
94+
validations:
95+
required: true
96+
- type: markdown
97+
attributes:
98+
value: |
99+
#
100+
#
101+
# Optional Questions:
102+
#
103+
- type: textarea
104+
id: get-help
105+
attributes:
106+
label: |
107+
108+
## Optional Questions:
109+
110+
### Is the bug inside a Dashboard Panel?
111+
112+
description: |
113+
If the bug appears inside a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations), please use the ["Get-Help" feature](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/). Select **copy to clipboard** and paste the data below.
114+
No need for backticks--this text will get formatted as a code-block.
115+
116+
What's a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations)?
117+
placeholder: Copy "get-help" data here
118+
value: Copy the panel's ["get-help" data](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/) here
119+
- type: dropdown
120+
id: gf-deployment
121+
attributes:
122+
label: Grafana Platform?
123+
description: |
124+
**How** are you running/deploying Grafana?
125+
options:
126+
- I use Grafana Cloud
127+
- Docker
128+
- Kubernetes
129+
- A package manager (APT, YUM, BREW, etc.)
130+
- A downloaded binary
131+
- Other
132+
- I don't know
133+
validations:
134+
required: false
135+
- type: input
136+
id: user-os
137+
attributes:
138+
label: User's OS?
139+
description: What operating system are you running locally?
140+
placeholder: "ex. MacOS Big Sur 11.7, or Ubuntu 20.04..."
141+
- type: input
142+
id: user-browser
143+
attributes:
144+
label: User's Browser?
145+
description: Is the bug occuring in Grafana's user-interface? If so, what browsers are you seeing the problem on? You may choose more than one.
146+
placeholder: "ex. Google Chrome Version 112.0.5615.137 (Official Build) (arm64)..."
147+
- type: dropdown
148+
id: regression
149+
attributes:
150+
label: Is this a Regression?
151+
description: |
152+
A regression means that the feature was working, then you upgraded, and now it's broken.
153+
options:
154+
- 'No'
155+
- 'Yes'
156+
validations:
157+
required: false
158+
- type: input
159+
id: gf-datasource
160+
attributes:
161+
label: Are Datasources involved?
162+
description: |
163+
Is this issue specific to a datasource plugin / plugins? Please list all that apply:
164+
placeholder: "ex. Elasticsearch 5.0.0 or Infinity 1.4.1 ..."
165+
- type: markdown
166+
attributes:
167+
value: |
168+
#
169+
#
170+
## Anything else to add?
171+
#
172+
- type: textarea
173+
id: extra
174+
attributes:
175+
label: |
176+
Anything else to add?
177+
description: Add any extra information here

‎.github/ISSUE_TEMPLATE/1-bug_report.md

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

‎.github/ISSUE_TEMPLATE/1-staff_issues.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Staff Issues
3+
about: Blank issue for Grafana staff members
4+
labels: 'internal'
5+
---

0 commit comments

Comments
 (0)