Skip to content

Commit

Permalink
docs: Add issue template (#104)
Browse files Browse the repository at this point in the history
Co-authored-by: Márk Sági-Kazár <[email protected]>
Co-authored-by: Ramiz Polić <[email protected]>
  • Loading branch information
3 people authored Nov 24, 2023
1 parent 433983d commit 4d82813
Show file tree
Hide file tree
Showing 3 changed files with 161 additions and 0 deletions.
107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: 🐛 Bug report
description: Report a bug to help us improve the Vault Secrets Webhook
labels: [kind/bug]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a bug report!
Please fill out the template below to make it easier to debug your problem.
If you are not sure if it is a bug or not, you can contact us via the available [support channels](https://bank-vaults.dev/docs/support/).
- type: checkboxes
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have searched the [issue tracker](https://www.github.com/bank-vaults/vault-secrets-webhook/issues) for an issue that matches the one I want to file, without success.
required: true
- label: I am not looking for support or already pursued the available [support channels](https://bank-vaults.dev/docs/support/) without success.
required: true
- label: I agree to follow the [Code of Conduct](https://bank-vaults.dev/docs/code-of-conduct/).
required: true
- type: input
attributes:
label: Vault Secrets Webhook Version
description: What version of the Vault Secrets Webhook are you using?
placeholder: 1.20.0
validations:
required: true
- type: dropdown
attributes:
label: Installation Type
description: How did you install the Operator?
options:
- Official Helm chart
- Custom Helm chart
- Other (specify below)
- type: input
attributes:
label: Bank-Vaults Version
description: What version of the Bank-Vaults CLI are you using?
placeholder: leave empty if you haven't specified a custom version
- type: input
attributes:
label: Kubernetes Version
description: What version of Kubernetes are you using?
placeholder: 1.27.0
validations:
required: true
- type: input
attributes:
label: Kubernetes Distribution/Provisioner
description: Which Kubernetes distribution/privisioner are you using?
placeholder: e.g. GKE, EKS, AKS, etc
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: A clear description of what actually happens.
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior if it is not self-explanatory.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
- type: textarea
attributes:
label: Configuration
description: Include Webhook deployment configuration data such as Helm chart values.
render: yaml
placeholder: |
**Chart values**
Your redacted custom Helm values data
**Other**
1. Vault CustomResource
```yaml
apiVersion: "vault.banzaicloud.com/v1alpha1"
kind: "Vault"
metadata:
name: "vault"
...
```
- type: textarea
attributes:
label: Logs
description: Webhook or application logs (if relevant).
render: shell
- type: textarea
attributes:
label: Additional Information
description: Links? References? Anything that will give us more context about the issue that you are encountering!
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: true
contact_links:
- name: 📖 Documentation enhancement
url: https://github.com/bank-vaults/bank-vaults.dev/issues
about: Suggest an improvement to the documentation

- name: 📚 Documentation
url: https://bank-vaults.dev/docs/mutating-webhook/
about: Check the documentation for help

- name: 💬 Slack channel
url: https://eti.cisco.com/slack
about: Please ask and answer questions here
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 🎉 Feature request
description: Suggest an idea for the Vault Secrets Webhook
labels: [kind/enhancement]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a feature request!
Please describe what you would like to change/add and why in detail by filling out the template below.
If you are not sure if your request fits into Dex, you can contact us via the available [support channels](https://bank-vaults.dev/docs/support/).
- type: checkboxes
attributes:
label: Preflight Checklist
description: Please ensure you've completed all of the following.
options:
- label: I have searched the [issue tracker](https://www.github.com/bank-vaults/vault-secrets-webhook/issues) for an issue that matches the one I want to file, without success.
required: true
- label: I agree to follow the [Code of Conduct](https://bank-vaults.dev/docs/code-of-conduct/).
required: true
- type: textarea
attributes:
label: Problem Description
description: A clear and concise description of the problem you are seeking to solve with this feature request.
validations:
required: true
- type: textarea
attributes:
label: Proposed Solution
description: A clear and concise description of what would you like to happen.
validations:
required: true
- type: textarea
attributes:
label: Alternatives Considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional Information
description: Add any other relevant context here.

0 comments on commit 4d82813

Please sign in to comment.