opensource/teleport
3
0
Fork 0
mirror of https://github.com/gravitational/teleport.git synced 2026-09-21 05:55:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve Github Issue Templates (#5459)

Browse Source 
- Improved Github Issue templates to ensure we are capturing information consistently between issue types.
- Fixed formatting of labels, to ensure labels are automatically applied.
- Updated a few links to new domain.
- Community Forum to Github Discussions
This commit is contained in:
Travis Swientek
2021-02-11 10:14:40 -06:00
committed by GitHub
parent 8ec5b6c22d
commit be37b54a8d
5 changed files with 105 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.md
+35 -13
View File
@@ -1,6 +1,7 @@
---
name: Bug Report 🐛
about: Something isn't working as expected? Here is the right place to report.
about: Something isn't working as expected? Report it here.
labels: bug
---
### Description
@@ -9,22 +10,43 @@ about: Something isn't working as expected? Here is the right place to report.
**What you expected to happen**:
**How to reproduce it (as minimally and precisely as possible)**:
### Environment
- Teleport version (use `teleport version`):
- Tsh version (use `tsh version`):
- OS (e.g. from `/etc/os-release`):
### Reproduction Steps
As minimally and precisely as possible, describe step-by-step how to reproduce the problem.
1.
2.
3.
### Server Details
- Teleport version (run `teleport version`):
- Server OS (e.g. from `/etc/os-release`):
- Where are you running Teleport? (e.g. AWS, GCP, Dedicated Hardware):
- Additional details:
**Browser environment**
### Client Details
- Tsh version (`tsh version`):
- Computer OS (e.g. Linux, macOS, Windows):
- Browser version (for UI-related issues):
- Installed via (e.g. apt, yum, brew, website download):
- Additional details:
- Browser Version (for UI-related issues):
- Install tools:
- Others:
### Debug Logs
Please include or attach debug logs, when appropriate. Obfuscate sensitive information!
- Start Teleport with --debug flag (`teleport --debug`)
- Run tsh with --debug flag (`tsh --debug`)
**Relevant Debug Logs If Applicable**
- `tsh --debug`
- `teleport --debug`
### Which platform(s)
- [ ] Teleport Open Source
- [ ] Teleport Cloud
- [x] Teleport Enterprise
- [ ] Other
### Which component(s)
- [x] Server Access
- [ ] Kubernetes Access
- [ ] Application Access
- [ ] Database Access
- [ ] CLI Clients
- [ ] Web Clients
- [ ] Other
.github/ISSUE_TEMPLATE/config.yml
+2 -2
View File
@@ -3,8 +3,8 @@ contact_links:
- name: Teleport Documentation
url: https://goteleport.com/teleport/docs/
about: Check out the Teleport documentation for answers to common questions
- name: Teleport community forum
url: https://community.goteleport.com/
- name: Teleport Discussions
url: https://github.com/gravitational/teleport/discussions
about: Ask Teleport related questions, answered by the Team and community.
- name: Request a Demo
url: https://goteleport.com/get-started/
.github/ISSUE_TEMPLATE/documentation.md
+21 -7
View File
@@ -1,13 +1,27 @@
---
name: Documentation 📝
about: Suggest better documentation for a particular tool or process.
about: Suggest improvements to Teleport's documentation.
labels: documentation
---
## Details
Describe the documentation improvements you wish to see.
## Summary
Describe the missing documentation. If it's a new feature, link to the feature ticket.
### Category
- [ ] New Feature
- [x] Improve Existing
- [ ] Remove Outdated
### Audience
Outline who this is for. e.g. CLI docs, new users, power users
### Which platform(s)
- [ ] Teleport Open Source
- [ ] Teleport Cloud
- [x] Teleport Enterprise
- [ ] Other
### Location
Should this docs update be a new guide, or an addition to an existing guide?
### Which component(s)
- [x] Server Access
- [ ] Kubernetes Access
- [ ] Application Access
- [ ] Database Access
- [ ] CLI Clients
- [ ] Web Clients
- [ ] Other
.github/ISSUE_TEMPLATE/feature_request.md
+26 -7
View File
@@ -1,12 +1,31 @@
---
name: Feature Request 💡
about: Suggest a new idea for the project.
about: Have an idea? Tell us about it.
labels: feature-request
---
### Feature Request
Describe in as much detail as possible what feature you would like to see added and how it should work.
### What
What would you like Teleport to do differently?
### Motivation
Describe why we should work on this feature request.
### How
How would you implement this?
### Who's it for?
OSS User, Pro, Enterprise, Cloud
### Why
Why do you need this?
### Workaround
If a workaround exists, please include it.
### Which platform(s)
- [ ] Teleport Open Source
- [ ] Teleport Cloud
- [x] Teleport Enterprise
- [ ] Other
### Which component(s)
- [x] Server Access
- [ ] Kubernetes Access
- [ ] Application Access
- [ ] Database Access
- [ ] CLI Clients
- [ ] Web Clients
- [ ] Other
.github/ISSUE_TEMPLATE/question.md
+21 -12
View File
@@ -1,25 +1,34 @@
---
name: Question 🤔
about: Usage question or discussion about Teleport.
labels: question
---
<!--
To make it easier for us to help you, please include as much useful information as possible.
Before opening a new issue, please search existing issues: https://github.com/gravitational/teleport/issues
Useful Links:
- Documentation: https://goteleport.com/teleport/docs/
- If you're an OSS user and have a general question, please ask in our community forum: https://community.goteleport.com/c/teleport
- For Pro and Enterprise users, please open a ticket via the Enterprise support portal: https://dashboard.gravitational.com/web/
Before opening a new issue, please search existing issues: https://github.com/gravitational/teleport/issues
- For Open Source users, please post your question in Github Discussions: https://github.com/gravitational/teleport/discussions
- For Enterprise customers, please open a support ticket via the Enterprise support portal: https://dashboard.gravitational.com/web/
-->
### What
What is your question?
## Summary
## Why
What is the motivation behind this question?
## Relevant information
### Which platform(s)
- [ ] Teleport Open Source
- [ ] Teleport Cloud
- [x] Teleport Enterprise
- [ ] Other
<!-- Provide as much useful information as you can -->
### Environment (if relevant)
### Which component(s)
- [x] Server Access
- [ ] Kubernetes Access
- [ ] Application Access
- [ ] Database Access
- [ ] CLI Clients
- [ ] Web Clients
- [ ] Other