Skip to content

Commit dabb491

Browse files
ranas-mukminovranas-mukminov
authored
Merge pull request #3 from ranas-mukminov/copilot/improve-documentation-and-examples
[WIP] Improve documentation and add practical examples
2 parents 32e4a2f + c00ba1c commit dabb491

File tree

12 files changed

+1585
-915
lines changed

12 files changed

+1585
-915
lines changed

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: ["ranas-mukminov"]
2+
custom: ["https://run-as-daemon.ru/support"]

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
name: Bug Report
2+
description: Report a bug or issue with the MongoDB Grafana datasource plugin
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps-to-reproduce
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. Execute query '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected-behavior
35+
attributes:
36+
label: Expected Behavior
37+
description: What did you expect to happen?
38+
placeholder: I expected...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual-behavior
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened?
47+
placeholder: Instead, I got...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: query
53+
attributes:
54+
label: MongoDB Query
55+
description: If applicable, paste the MongoDB aggregation query that's causing the issue
56+
placeholder: |
57+
db.collection.aggregate([
58+
{ "$match": { ... } }
59+
])
60+
render: javascript
61+
62+
- type: input
63+
id: grafana-version
64+
attributes:
65+
label: Grafana Version
66+
description: What version of Grafana are you using?
67+
placeholder: e.g., 9.5.2, 10.0.0
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: mongodb-version
73+
attributes:
74+
label: MongoDB Version
75+
description: What version of MongoDB are you using?
76+
placeholder: e.g., 5.0.15, 6.0.4
77+
validations:
78+
required: true
79+
80+
- type: input
81+
id: plugin-version
82+
attributes:
83+
label: Plugin Version
84+
description: What version of the MongoDB Grafana plugin are you using?
85+
placeholder: e.g., 0.8.1
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: nodejs-version
91+
attributes:
92+
label: Node.js Version
93+
description: What version of Node.js is running the proxy server?
94+
placeholder: e.g., 16.20.0, 18.16.0
95+
validations:
96+
required: true
97+
98+
- type: dropdown
99+
id: deployment
100+
attributes:
101+
label: Deployment Method
102+
description: How are you deploying the plugin and proxy?
103+
options:
104+
- Manual installation
105+
- Docker Compose
106+
- Kubernetes
107+
- Other (please describe in additional context)
108+
validations:
109+
required: true
110+
111+
- type: input
112+
id: os
113+
attributes:
114+
label: Operating System
115+
description: What OS is the proxy server running on?
116+
placeholder: e.g., Ubuntu 22.04, macOS 13.3, Windows 11
117+
validations:
118+
required: true
119+
120+
- type: textarea
121+
id: logs
122+
attributes:
123+
label: Relevant Logs
124+
description: Please paste any relevant log output (proxy server logs, Grafana logs, browser console)
125+
placeholder: Paste logs here...
126+
render: shell
127+
128+
- type: textarea
129+
id: screenshots
130+
attributes:
131+
label: Screenshots
132+
description: If applicable, add screenshots to help explain your problem
133+
134+
- type: textarea
135+
id: additional-context
136+
attributes:
137+
label: Additional Context
138+
description: Add any other context about the problem here (network setup, security configuration, etc.)
139+
140+
- type: checkboxes
141+
id: checklist
142+
attributes:
143+
label: Pre-submission Checklist
144+
description: Please confirm you've done the following before submitting
145+
options:
146+
- label: I have searched existing issues to ensure this isn't a duplicate
147+
required: true
148+
- label: I have included all relevant version information
149+
required: true
150+
- label: I have provided steps to reproduce the issue
151+
required: true
152+
- label: I have checked the plugin and proxy logs for errors
153+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for the MongoDB Grafana datasource plugin
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like to see
25+
placeholder: I would like to be able to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Have you considered any alternative solutions or workarounds?
34+
placeholder: I've tried... but it doesn't work because...
35+
36+
- type: dropdown
37+
id: feature-type
38+
attributes:
39+
label: Feature Type
40+
description: What type of feature is this?
41+
options:
42+
- New query capability
43+
- Dashboard/visualization enhancement
44+
- Proxy server improvement
45+
- Performance optimization
46+
- Documentation improvement
47+
- Security enhancement
48+
- Developer experience
49+
- Other
50+
validations:
51+
required: true
52+
53+
- type: dropdown
54+
id: priority
55+
attributes:
56+
label: Priority
57+
description: How important is this feature to you?
58+
options:
59+
- Nice to have
60+
- Would significantly improve my workflow
61+
- Critical for my use case
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: use-case
67+
attributes:
68+
label: Use Case
69+
description: Describe your specific use case for this feature
70+
placeholder: |
71+
I need this feature because...
72+
It would help me to...
73+
My workflow involves...
74+
validations:
75+
required: true
76+
77+
- type: textarea
78+
id: example
79+
attributes:
80+
label: Example
81+
description: If applicable, provide an example of how this feature would work
82+
placeholder: |
83+
For example, I would write a query like:
84+
db.collection.aggregate([...])
85+
86+
And it would produce...
87+
88+
- type: textarea
89+
id: mockup
90+
attributes:
91+
label: Mockups or Examples
92+
description: If applicable, add mockups, screenshots, or examples from other tools
93+
94+
- type: checkboxes
95+
id: compatibility
96+
attributes:
97+
label: Compatibility
98+
description: Should this feature maintain backward compatibility?
99+
options:
100+
- label: This feature should maintain backward compatibility
101+
- label: This feature may require breaking changes (explain in additional context)
102+
103+
- type: dropdown
104+
id: contribution
105+
attributes:
106+
label: Contribution
107+
description: Are you willing to contribute this feature?
108+
options:
109+
- No, I'm just suggesting it
110+
- Yes, I'm willing to submit a pull request
111+
- Yes, but I need guidance on how to implement it
112+
validations:
113+
required: true
114+
115+
- type: textarea
116+
id: additional-context
117+
attributes:
118+
label: Additional Context
119+
description: Add any other context, links, or references about the feature request here
120+
121+
- type: checkboxes
122+
id: checklist
123+
attributes:
124+
label: Pre-submission Checklist
125+
description: Please confirm you've done the following before submitting
126+
options:
127+
- label: I have searched existing issues and discussions to ensure this isn't a duplicate
128+
required: true
129+
- label: I have clearly described the problem and proposed solution
130+
required: true
131+
- label: I understand this is an open-source project with no guaranteed timelines
132+
required: true

0 commit comments

Comments
 (0)