mirror of
https://github.com/fankes/beszel.git
synced 2025-10-18 17:29:28 +08:00
docs(config): Update issue and discussion templates
This commit is contained in:
hank
61
.github/DISCUSSION_TEMPLATE/support.yml
vendored
Normal file
61
.github/DISCUSSION_TEMPLATE/support.yml
vendored
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
### Before opening a discussion:
|
||||||
|
|
||||||
|
- Check the [common issues guide](https://beszel.dev/guide/common-issues).
|
||||||
|
- Search existing [issues](https://github.com/henrygd/beszel/issues) and [discussions](https://github.com/henrygd/beszel/discussions) (including closed).
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: A clear and concise description of the issue or question. If applicable, add screenshots to help explain your problem.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: system
|
||||||
|
attributes:
|
||||||
|
label: OS / Architecture
|
||||||
|
placeholder: linux/amd64 (agent), freebsd/arm64 (hub)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Beszel version
|
||||||
|
placeholder: 0.9.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: install-method
|
||||||
|
attributes:
|
||||||
|
label: Installation method
|
||||||
|
options:
|
||||||
|
- Docker
|
||||||
|
- Binary
|
||||||
|
- Nix
|
||||||
|
- Unraid
|
||||||
|
- Coolify
|
||||||
|
- Other (please describe above)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: config
|
||||||
|
attributes:
|
||||||
|
label: Configuration
|
||||||
|
description: Please provide any relevant service configuration
|
||||||
|
render: yaml
|
||||||
|
- type: textarea
|
||||||
|
id: hub-logs
|
||||||
|
attributes:
|
||||||
|
label: Hub Logs
|
||||||
|
description: Check the logs page in PocketBase (`/_/#/logs`) for relevant errors (copy JSON).
|
||||||
|
render: json
|
||||||
|
- type: textarea
|
||||||
|
id: agent-logs
|
||||||
|
attributes:
|
||||||
|
label: Agent Logs
|
||||||
|
description: Please provide any logs from the agent, if relevant. Use `LOG_LEVEL=debug` for more info.
|
||||||
|
render: shell
|
||||||
78
.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml
vendored
78
.github/ISSUE_TEMPLATE/BUG_REPORT_FORM.yml
vendored
@@ -1,78 +0,0 @@
|
|||||||
name: Bug Report
|
|
||||||
description: Use this template to report a bug or issue.
|
|
||||||
title: "[Bug]: "
|
|
||||||
labels: ["bug"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to fill out this bug report! You should only use this form for issues, to request a change or feature use the [feature request form](https://github.com/henrygd/beszel).
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Pre-work
|
|
||||||
description: |
|
|
||||||
Before opening an issue make sure you've checked the resources below first, any issues that could have been solved by reading the docs or existing issues will be closed.
|
|
||||||
options:
|
|
||||||
- label: I have read the [docs](https://beszel.dev/guide/what-is-beszel).
|
|
||||||
required: true
|
|
||||||
- label: I have searched open and closed issues.
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Explain the issue you experienced, please be clear and concise.
|
|
||||||
placeholder: I went to the coffee pot and it was empty.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: expected-behavior
|
|
||||||
attributes:
|
|
||||||
label: Expected Behavior
|
|
||||||
description: In a perfect world, what should have happened?
|
|
||||||
placeholder: When I got to the coffee pot, it should have been full.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: steps-to-reproduce
|
|
||||||
attributes:
|
|
||||||
label: Steps to Reproduce
|
|
||||||
description: Describe how to reproduce the issue in repeatable steps.
|
|
||||||
placeholder: |
|
|
||||||
1. Go to the coffee pot.
|
|
||||||
2. Make more coffee.
|
|
||||||
3. Pour it into a cup.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
id: deployment-environment
|
|
||||||
attributes:
|
|
||||||
label: Deployment Environment
|
|
||||||
description: How did you deploy the application?
|
|
||||||
options:
|
|
||||||
- Docker Compose
|
|
||||||
- Docker Run
|
|
||||||
- Binary
|
|
||||||
default: 0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
|
||||||
id: browsers
|
|
||||||
attributes:
|
|
||||||
label: What browser(s) are you seeing the problem on?
|
|
||||||
placeholder: Chrome, Firefox, Safari, etc.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: input
|
|
||||||
id: operating-system
|
|
||||||
attributes:
|
|
||||||
label: What Operation System are you seeing the problem on?
|
|
||||||
placeholder: Ubuntu, Rocky Linux, Windows, MacOs, etc.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: logs
|
|
||||||
attributes:
|
|
||||||
label: Logs
|
|
||||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
|
||||||
render: shell
|
|
||||||
36
.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml
vendored
36
.github/ISSUE_TEMPLATE/FEATURE_REQUEST_FORM.yml
vendored
@@ -1,36 +0,0 @@
|
|||||||
name: Feature Request
|
|
||||||
description: Use this template for requesting a new feature or change.
|
|
||||||
title: "[Feature]: "
|
|
||||||
labels: ["enhancement"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
You should only use this form to request a change or new feature, to report a bug or issue use the [bug report form](https://github.com/henrygd/beszel).
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Pre-work
|
|
||||||
options:
|
|
||||||
- label: I have searched open and closed feature request to make sure this or similar feature request does not already exist.
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
id: idea-section
|
|
||||||
attributes:
|
|
||||||
label: Which part of the application does your feature belong to?
|
|
||||||
description: Select the section of the application that your feature pertains to.
|
|
||||||
options:
|
|
||||||
- Charts
|
|
||||||
- Notifications
|
|
||||||
- Metrics Collection
|
|
||||||
- Other
|
|
||||||
default: 0
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Describe the solution or feature you'd like, you should also mention if this solves a problem.
|
|
||||||
placeholder: Be sure to keep it clear and concise.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
90
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
90
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
name: 🐛 Bug report
|
||||||
|
description: Report a new bug or issue.
|
||||||
|
title: "[Bug]: "
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
### Thanks for taking the time to fill out this bug report!
|
||||||
|
|
||||||
|
- For more general support, please [start a support thread](https://github.com/henrygd/beszel/discussions/new?category=support).
|
||||||
|
- To request a change or feature, use the [feature request form](https://github.com/henrygd/beszel/issues/new?template=feature_request.yml).
|
||||||
|
|
||||||
|
### Before submitting a bug report:
|
||||||
|
|
||||||
|
- Check the [common issues guide](https://beszel.dev/guide/common-issues).
|
||||||
|
- Search existing [issues](https://github.com/henrygd/beszel/issues) and [discussions](https://github.com/henrygd/beszel/discussions) (including closed).
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Explain the issue you experienced clearly and concisely.
|
||||||
|
placeholder: I went to the coffee pot and it was empty.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: In a perfect world, what should have happened?
|
||||||
|
placeholder: When I got to the coffee pot, it should have been full.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: steps-to-reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: Describe how to reproduce the issue in repeatable steps.
|
||||||
|
placeholder: |
|
||||||
|
1. Go to the coffee pot.
|
||||||
|
2. Make more coffee.
|
||||||
|
3. Pour it into a cup.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: system
|
||||||
|
attributes:
|
||||||
|
label: OS / Architecture
|
||||||
|
placeholder: linux/amd64 (agent), freebsd/arm64 (hub)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Beszel version
|
||||||
|
placeholder: 0.9.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: install-method
|
||||||
|
attributes:
|
||||||
|
label: Installation method
|
||||||
|
default: 0
|
||||||
|
options:
|
||||||
|
- Docker
|
||||||
|
- Binary
|
||||||
|
- Nix
|
||||||
|
- Unraid
|
||||||
|
- Coolify
|
||||||
|
- Other (please describe above)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: config
|
||||||
|
attributes:
|
||||||
|
label: Configuration
|
||||||
|
description: Please provide any relevant service configuration
|
||||||
|
render: yaml
|
||||||
|
- type: textarea
|
||||||
|
id: hub-logs
|
||||||
|
attributes:
|
||||||
|
label: Hub Logs
|
||||||
|
description: Check the logs page in PocketBase (`/_/#/logs`) for relevant errors (copy JSON).
|
||||||
|
render: json
|
||||||
|
- type: textarea
|
||||||
|
id: agent-logs
|
||||||
|
attributes:
|
||||||
|
label: Agent Logs
|
||||||
|
description: Please provide any logs from the agent, if relevant. Use `LOG_LEVEL=debug` for more info.
|
||||||
|
render: shell
|
||||||
15
.github/ISSUE_TEMPLATE/config.yml
vendored
15
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,8 +1,11 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: GitHub Community Support
|
- name: 💬 Support and questions
|
||||||
url: https://github.com/orgs/community/discussions
|
url: https://github.com/henrygd/beszel/discussions
|
||||||
about: Please ask and answer questions here.
|
about: Ask and answer questions here.
|
||||||
- name: GitHub Security Bug Bounty
|
- name: ℹ️ View the Common Issues page
|
||||||
url: https://bounty.github.com/
|
url: https://beszel.dev/guide/common-issues
|
||||||
about: Please report security vulnerabilities here.
|
about: Find information about commonly encountered problems.
|
||||||
|
- name: 🔐 Report a security vulnerability
|
||||||
|
url: https://github.com/henrygd/beszel/security/advisories/new
|
||||||
|
about: You can open an issue if the vulnerability is low severity.
|
||||||
|
|||||||
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
23
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
name: 🚀 Feature request
|
||||||
|
description: Request a new feature or change.
|
||||||
|
title: "[Feature]: "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: Before submitting, please search existing [issues](https://github.com/henrygd/beszel/issues) and [discussions](https://github.com/henrygd/beszel/discussions) (including closed).
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the feature you would like to see
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe how you would like to see this feature implemented
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe any alternatives you've considered
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
Reference in New Issue
Block a user