mirror of
https://git.mirrors.martin98.com/https://github.com/SigNoz/signoz
synced 2025-06-04 11:25:52 +08:00
chore: update dashboard contributing doc and issue template (#6029)
* chore: update dashboard contributing doc and issue template * chore: update issue template
This commit is contained in:
parent
0077714cb0
commit
fc7a94fa66
49
.github/ISSUE_TEMPLATE/request_dashboard.md
vendored
49
.github/ISSUE_TEMPLATE/request_dashboard.md
vendored
@ -1,58 +1,49 @@
|
|||||||
---
|
---
|
||||||
name: Request Dashboard
|
name: Request Dashboard
|
||||||
about: Request a new dashboard for the SigNoz Dashboards repository
|
about: Request a new dashboard for the SigNoz Dashboards repository
|
||||||
title: ''
|
title: '[Dashboard Request] '
|
||||||
labels: 'dashboard-template'
|
labels: 'dashboard-template'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📝 Dashboard Request Template
|
<!-- Use this template to request a new dashboard for the SigNoz Dashboards repository. Providing detailed information will help us understand your needs better and speed up the dashboard creation process. -->
|
||||||
|
|
||||||
*Use this template to request a new dashboard for the SigNoz Dashboards repository. Please provide as much detail as possible to help us understand your needs.*
|
## Dashboard Name
|
||||||
|
|
||||||
---
|
<!-- Provide the name for the requested dashboard. Be specific (e.g., "MySQL Monitoring Dashboard"). -->
|
||||||
|
|
||||||
### 1. Dashboard Name
|
## Expected Dashboard Sections and Panels
|
||||||
|
|
||||||
Name of the requested dashboard (e.g., MySQL Monitoring Dashboard):
|
(Can be tweaked (add or remove panels/sections) according to available metrics)
|
||||||
|
|
||||||
---
|
### Section Name
|
||||||
|
|
||||||
### 2. Expected Dashboard Sections and Panels
|
<!-- Brief description of what this section should display (e.g., "Resource usage metrics for MySQL database"). -->
|
||||||
|
|
||||||
#### Section Name
|
### Panel Name
|
||||||
|
|
||||||
Brief description of the section (e.g., "Resource usage metrics for MySQL database").
|
<!-- Description of the panel (e.g., "Displays current CPU usage, memory usage, etc."). -->
|
||||||
|
|
||||||
#### Panel Name
|
<!-- - **Example:**
|
||||||
|
|
||||||
Panel description (e.g., "Value-type panels displaying current CPU usage, memory usage, etc.").
|
|
||||||
|
|
||||||
- **Example:**
|
|
||||||
- **Section**: Resource Metrics
|
- **Section**: Resource Metrics
|
||||||
- **Panel**: CPU Usage - Displays the current CPU usage across all database instances.
|
- **Panel**: CPU Usage - Displays the current CPU usage across all database instances.
|
||||||
- **Panel**: Memory Usage - Displays the total memory used by the MySQL process.
|
- **Panel**: Memory Usage - Displays the total memory used by the MySQL process. -->
|
||||||
|
|
||||||
(Repeat this format for additional sections and panels)
|
<!-- Repeat this format for any additional sections or panels. -->
|
||||||
|
|
||||||
---
|
## Expected Dashboard Variables
|
||||||
|
|
||||||
### 3. Expected Variables
|
<!-- List any dashboard variables that should be included in the dashboard. Examples could be `deployment.environment`, `hostname`, `region`, etc. -->
|
||||||
|
|
||||||
List any variables you expect to use in the dashboard (e.g., `deployment.environment`, `hostname`, etc.).
|
## Additional Comments or Requirements
|
||||||
|
|
||||||
---
|
<!-- Include any other details, special requirements, or specific visualizations you'd like to request for this dashboard. -->
|
||||||
|
|
||||||
### 4. Additional Comments or Requirements
|
## References or Screenshots
|
||||||
|
|
||||||
Any additional details or special requirements for the dashboard?
|
<!-- Add any references or screenshots of requested dashboard if available. -->
|
||||||
|
|
||||||
---
|
## 📋 Notes
|
||||||
|
|
||||||
### 📋 Notes
|
|
||||||
|
|
||||||
Please review the [CONTRIBUTING.md](https://github.com/SigNoz/dashboards/blob/main/CONTRIBUTING.md) for guidelines on dashboard structure, naming conventions, and how to submit a pull request.
|
Please review the [CONTRIBUTING.md](https://github.com/SigNoz/dashboards/blob/main/CONTRIBUTING.md) for guidelines on dashboard structure, naming conventions, and how to submit a pull request.
|
||||||
|
|
||||||
---
|
|
||||||
Thank you for your request! We will review it and provide feedback or guidance as necessary.
|
|
||||||
|
@ -30,6 +30,7 @@ Also, have a look at these [good first issues label](https://github.com/SigNoz/s
|
|||||||
- [To run ClickHouse setup](#41-to-run-clickhouse-setup-recommended-for-local-development)
|
- [To run ClickHouse setup](#41-to-run-clickhouse-setup-recommended-for-local-development)
|
||||||
- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart-)
|
- [Contribute to SigNoz Helm Chart](#5-contribute-to-signoz-helm-chart-)
|
||||||
- [To run helm chart for local development](#51-to-run-helm-chart-for-local-development)
|
- [To run helm chart for local development](#51-to-run-helm-chart-for-local-development)
|
||||||
|
- [Contribute to Dashboards](#6-contribute-to-dashboards-)
|
||||||
- [Other Ways to Contribute](#other-ways-to-contribute)
|
- [Other Ways to Contribute](#other-ways-to-contribute)
|
||||||
|
|
||||||
# 1. General Instructions 📝
|
# 1. General Instructions 📝
|
||||||
@ -369,6 +370,17 @@ curl -sL https://github.com/SigNoz/signoz/raw/develop/sample-apps/hotrod/hotrod-
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# 6. Contribute to Dashboards 📈
|
||||||
|
|
||||||
|
**Need to Update: [https://github.com/SigNoz/dashboards](https://github.com/SigNoz/dashboards)**
|
||||||
|
|
||||||
|
To contribute a new dashboard template for any service, follow the contribution guidelines in the [Dashboard Contributing Guide](https://github.com/SigNoz/dashboards/blob/main/CONTRIBUTING.md). In brief:
|
||||||
|
|
||||||
|
1. Create a dashboard JSON file.
|
||||||
|
2. Add a README file explaining the dashboard, the metrics ingested, and the configurations needed.
|
||||||
|
3. Include screenshots of the dashboard in the `assets/` directory.
|
||||||
|
4. Submit a pull request for review.
|
||||||
|
|
||||||
## Other Ways to Contribute
|
## Other Ways to Contribute
|
||||||
|
|
||||||
There are many other ways to get involved with the community and to participate in this project:
|
There are many other ways to get involved with the community and to participate in this project:
|
||||||
@ -379,7 +391,6 @@ There are many other ways to get involved with the community and to participate
|
|||||||
- Help answer questions on forums such as Stack Overflow and [SigNoz Community Slack Channel](https://signoz.io/slack).
|
- Help answer questions on forums such as Stack Overflow and [SigNoz Community Slack Channel](https://signoz.io/slack).
|
||||||
- Tell others about the project on Twitter, your blog, etc.
|
- Tell others about the project on Twitter, your blog, etc.
|
||||||
|
|
||||||
|
|
||||||
Again, Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
|
Again, Feel free to ping us on [`#contributing`](https://signoz-community.slack.com/archives/C01LWQ8KS7M) or [`#contributing-frontend`](https://signoz-community.slack.com/archives/C027134DM8B) on our slack community if you need any help on this :)
|
||||||
|
|
||||||
Thank You!
|
Thank You!
|
||||||
|
Loading…
x
Reference in New Issue
Block a user