Change issue templates to use HTML comments + tip about code blocks

Signed-off-by: Maartje Eyskens <maartje@eyskens.me>
This commit is contained in:
Maartje Eyskens 2020-11-05 12:28:26 +01:00
parent fda1c091e3
commit 2c2717233c
2 changed files with 31 additions and 21 deletions

View File

@ -4,27 +4,36 @@ about: Report a bug to help us improve cert-manager
---
> Bugs should be filed for issues encountered whilst operating cert-manager.
> You should first attempt to resolve your issues through the community support
> channels, e.g. Slack, in order to rule out individual configuration errors.
> Please provide as much detail as possible.
<!--
Bugs should be filed for issues encountered whilst operating cert-manager.
You should first attempt to resolve your issues through the community support
channels, e.g. Slack, in order to rule out individual configuration errors.
Please provide as much detail as possible.
-->
**Describe the bug**:
A clear and concise description of what the bug is.
<!--
A clear and concise description of what the bug is.
Tip: you can use
```
<code here>
```
for code blocks of your kubectl output or YAML files.
-->
**Expected behaviour**:
A concise description of what you expected to happen.
<!--A concise description of what you expected to happen.-->
**Steps to reproduce the bug**:
Steps to reproduce the bug should be clear and easily reproducible to help people
gain an understanding of the problem.
<!--Steps to reproduce the bug should be clear and easily reproducible to help people
gain an understanding of the problem.-->
**Anything else we need to know?**:
**Environment details:**:
- Kubernetes version (e.g. v1.10.2):
- Cloud-provider/provisioner (e.g. GKE, kops AWS, etc):
- cert-manager version (e.g. v0.4.0):
- Install method (e.g. helm or static manifests):
- Kubernetes version:
- Cloud-provider/provisioner:
- cert-manager version:
- Install method: e.g. helm/static manifests
/kind bug

View File

@ -5,21 +5,22 @@ about: Suggest an idea to improve cert-manager
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is
<!--A clear and concise description of what the problem is-->
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
<!--A clear and concise description of what you want to happen.-->
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
<!--A clear and concise description of any alternative solutions or features you've considered.-->
**Additional context**
Add any other context about the feature request here.
<!--Add any other context about the feature request here.-->
**Environment details (remove if not applicable)**:
- Kubernetes version:
- Cloud-provider/provisioner:
- cert-manager version:
- Install method: e.g. helm/static manifests
**Environment details (if applicable)**:
- Kubernetes version (e.g. v1.10.2):
- Cloud-provider/provisioner (e.g. GKE, kops AWS, etc):
- cert-manager version (e.g. v0.4.0):
- Install method (e.g. helm or static manifests):
/kind feature