Merge pull request #4 from ranas-mukminov/copilot/update-repo-documentation

Complete documentation and repository infrastructure for run-as-daemon fork

Author: ranas-mukminov

.github/FUNDING.yml

@@ -1,2 +1,4 @@
-github: ["ranas-mukminov"]
+# These are supported funding model platforms
+
+github: [ranas-mukminov]
 custom: ["https://run-as-daemon.ru/support"]

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,70 +1,61 @@
 name: Bug Report
-description: Report a bug or issue with the MongoDB Grafana datasource plugin
-title: "[Bug]: "
+description: Report a bug or issue with the MongoDB Grafana plugin
+title: "[BUG] "
 labels: ["bug", "needs-triage"]
+assignees: []
+
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose and fix the issue.
+        Thank you for reporting a bug! Please fill out the information below to help us resolve the issue.
 
   - type: textarea
     id: description
     attributes:
       label: Bug Description
       description: A clear and concise description of what the bug is.
-      placeholder: What happened?
+      placeholder: Describe the bug...
     validations:
       required: true
 
   - type: textarea
-    id: steps-to-reproduce
+    id: steps
     attributes:
       label: Steps to Reproduce
       description: Steps to reproduce the behavior
       placeholder: |
         1. Go to '...'
-        2. Click on '...'
-        3. Execute query '...'
+        2. Configure '...'
+        3. Run query '...'
         4. See error
     validations:
       required: true
 
   - type: textarea
-    id: expected-behavior
+    id: expected
     attributes:
       label: Expected Behavior
-      description: What did you expect to happen?
-      placeholder: I expected...
+      description: What you expected to happen
+      placeholder: Describe what should happen...
     validations:
       required: true
 
   - type: textarea
-    id: actual-behavior
+    id: actual
     attributes:
       label: Actual Behavior
-      description: What actually happened?
-      placeholder: Instead, I got...
+      description: What actually happened
+      placeholder: Describe what actually happened...
     validations:
       required: true
 
-  - type: textarea
-    id: query
-    attributes:
-      label: MongoDB Query
-      description: If applicable, paste the MongoDB aggregation query that's causing the issue
-      placeholder: |
-        db.collection.aggregate([
-          { "$match": { ... } }
-        ])
-      render: javascript
-
   - type: input
     id: grafana-version
     attributes:
       label: Grafana Version
       description: What version of Grafana are you using?
-      placeholder: e.g., 9.5.2, 10.0.0
+      placeholder: e.g., 10.2.0
     validations:
       required: true
 
@@ -73,15 +64,15 @@ body:
     attributes:
       label: MongoDB Version
       description: What version of MongoDB are you using?
-      placeholder: e.g., 5.0.15, 6.0.4
+      placeholder: e.g., 6.0.3
     validations:
       required: true
 
   - type: input
     id: plugin-version
     attributes:
       label: Plugin Version
-      description: What version of the MongoDB Grafana plugin are you using?
+      description: What version of the mongodb-grafana plugin are you using?
       placeholder: e.g., 0.8.1
     validations:
       required: true
@@ -90,38 +81,45 @@ body:
     id: nodejs-version
     attributes:
       label: Node.js Version
-      description: What version of Node.js is running the proxy server?
-      placeholder: e.g., 16.20.0, 18.16.0
+      description: What version of Node.js is the proxy server running on?
+      placeholder: e.g., 16.20.0
     validations:
-      required: true
+      required: false
 
   - type: dropdown
-    id: deployment
+    id: os
     attributes:
-      label: Deployment Method
-      description: How are you deploying the plugin and proxy?
+      label: Operating System
+      description: What operating system are you using?
       options:
-        - Manual installation
-        - Docker Compose
-        - Kubernetes
-        - Other (please describe in additional context)
+        - Linux
+        - macOS
+        - Windows
+        - Docker
+        - Other
     validations:
       required: true
 
-  - type: input
-    id: os
+  - type: textarea
+    id: query
     attributes:
-      label: Operating System
-      description: What OS is the proxy server running on?
-      placeholder: e.g., Ubuntu 22.04, macOS 13.3, Windows 11
-    validations:
-      required: true
+      label: MongoDB Query
+      description: If applicable, paste the MongoDB aggregation query you're using
+      placeholder: |
+        db.collection.aggregate([
+          // Your query here
+        ])
+      render: javascript
 
   - type: textarea
     id: logs
     attributes:
       label: Relevant Logs
-      description: Please paste any relevant log output (proxy server logs, Grafana logs, browser console)
+      description: |
+        Please include relevant log output from:
+        - Grafana server logs
+        - MongoDB proxy logs
+        - Browser console (if applicable)
       placeholder: Paste logs here...
       render: shell
 
@@ -132,22 +130,22 @@ body:
       description: If applicable, add screenshots to help explain your problem
 
   - type: textarea
-    id: additional-context
+    id: additional
     attributes:
       label: Additional Context
-      description: Add any other context about the problem here (network setup, security configuration, etc.)
+      description: Add any other context about the problem here
 
   - type: checkboxes
     id: checklist
     attributes:
       label: Pre-submission Checklist
-      description: Please confirm you've done the following before submitting
+      description: Please confirm the following before submitting
       options:
-        - label: I have searched existing issues to ensure this isn't a duplicate
+        - label: I have searched existing issues to ensure this bug hasn't been reported
           required: true
         - label: I have included all relevant version information
           required: true
         - label: I have provided steps to reproduce the issue
           required: true
-        - label: I have checked the plugin and proxy logs for errors
-          required: true
+        - label: I have included relevant logs or error messages
+          required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,19 +1,23 @@
 name: Feature Request
-description: Suggest a new feature or enhancement for the MongoDB Grafana datasource plugin
-title: "[Feature]: "
+description: Suggest a new feature or enhancement for the MongoDB Grafana plugin
+title: "[FEATURE] "
 labels: ["enhancement", "needs-triage"]
+assignees: []
+
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.
+        Thank you for suggesting a feature! Please fill out the information below.
+        
+        **Note**: This is a community-maintained fork. Feature implementation depends on community contributions and maintainer availability.
 
   - type: textarea
     id: problem
     attributes:
       label: Problem Statement
       description: Is your feature request related to a problem? Please describe.
-      placeholder: I'm always frustrated when...
+      placeholder: I'm frustrated when... / I need to... / It would be helpful if...
     validations:
       required: true
 
@@ -22,30 +26,32 @@ body:
     attributes:
       label: Proposed Solution
       description: Describe the solution you'd like to see
-      placeholder: I would like to be able to...
+      placeholder: I would like to see... / The plugin should... / It would work like...
     validations:
       required: true
 
   - type: textarea
     id: alternatives
     attributes:
       label: Alternatives Considered
-      description: Have you considered any alternative solutions or workarounds?
-      placeholder: I've tried... but it doesn't work because...
+      description: Describe any alternative solutions or features you've considered
+      placeholder: |
+        - Alternative 1: ...
+        - Alternative 2: ...
+        - Current workaround: ...
 
   - type: dropdown
-    id: feature-type
+    id: component
     attributes:
-      label: Feature Type
-      description: What type of feature is this?
+      label: Component
+      description: Which component would this feature affect?
       options:
-        - New query capability
-        - Dashboard/visualization enhancement
-        - Proxy server improvement
-        - Performance optimization
-        - Documentation improvement
-        - Security enhancement
-        - Developer experience
+        - Grafana Plugin (Frontend UI)
+        - MongoDB Proxy Server (Backend)
+        - Query Handling
+        - Configuration
+        - Documentation
+        - Build/Deployment
         - Other
     validations:
       required: true
@@ -56,9 +62,10 @@ body:
       label: Priority
       description: How important is this feature to you?
       options:
-        - Nice to have
-        - Would significantly improve my workflow
-        - Critical for my use case
+        - Critical - Blocking my use of the plugin
+        - High - Significantly improves my workflow
+        - Medium - Nice to have enhancement
+        - Low - Minor improvement
     validations:
       required: true
 
@@ -68,65 +75,62 @@ body:
       label: Use Case
       description: Describe your specific use case for this feature
       placeholder: |
-        I need this feature because...
-        It would help me to...
-        My workflow involves...
+        In my project, we need to...
+        We have X number of dashboards that...
+        Our team frequently needs to...
     validations:
       required: true
 
   - type: textarea
     id: example
     attributes:
       label: Example
-      description: If applicable, provide an example of how this feature would work
+      description: If applicable, provide a concrete example of how this feature would be used
       placeholder: |
-        For example, I would write a query like:
-        db.collection.aggregate([...])
-        
-        And it would produce...
+        1. User configures...
+        2. User runs query...
+        3. System displays...
 
   - type: textarea
     id: mockup
     attributes:
-      label: Mockups or Examples
-      description: If applicable, add mockups, screenshots, or examples from other tools
+      label: Mockup/Screenshot
+      description: If applicable, add mockups or screenshots to help explain your feature
 
   - type: checkboxes
-    id: compatibility
+    id: upstream
     attributes:
-      label: Compatibility
-      description: Should this feature maintain backward compatibility?
+      label: Upstream Compatibility
+      description: Should this feature be compatible with the upstream project?
       options:
-        - label: This feature should maintain backward compatibility
-        - label: This feature may require breaking changes (explain in additional context)
+        - label: This feature should maintain compatibility with JamesOsgood/mongodb-grafana
+        - label: This is a fork-specific enhancement that doesn't need upstream compatibility
 
-  - type: dropdown
+  - type: checkboxes
     id: contribution
     attributes:
       label: Contribution
-      description: Are you willing to contribute this feature?
+      description: Are you willing to contribute to implementing this feature?
       options:
-        - No, I'm just suggesting it
-        - Yes, I'm willing to submit a pull request
-        - Yes, but I need guidance on how to implement it
-    validations:
-      required: true
+        - label: I am willing to submit a pull request for this feature
+        - label: I can help test this feature once implemented
+        - label: I can help with documentation for this feature
 
   - type: textarea
-    id: additional-context
+    id: additional
     attributes:
       label: Additional Context
-      description: Add any other context, links, or references about the feature request here
+      description: Add any other context, links, or references about the feature request
 
   - type: checkboxes
     id: checklist
     attributes:
       label: Pre-submission Checklist
-      description: Please confirm you've done the following before submitting
+      description: Please confirm the following before submitting
       options:
-        - label: I have searched existing issues and discussions to ensure this isn't a duplicate
+        - label: I have searched existing issues to ensure this hasn't been requested
           required: true
-        - label: I have clearly described the problem and proposed solution
+        - label: I have described the problem and proposed solution clearly
           required: true
-        - label: I understand this is an open-source project with no guaranteed timelines
+        - label: I understand this is a community project with no guaranteed implementation timeline
           required: true