mirror of https://github.com/docker/docs.git
Merge pull request #17331 from dvdksn/chore/issue-tpl-form-schema
chore: update issue template to use forms
This commit is contained in:
David Karlsson
GitHub
commit
c9a9970f5e
|
|
@ -1,41 +0,0 @@
|
|||
|
||||
<!--
|
||||
|
||||
## READ ME FIRST
|
||||
|
||||
This repository is for reporting issues related to Docker Documentation. Before submitting a new issue, check whether the issue has already been reported. You can join the discussion using an emoji, or by adding a comment to an existing issue.
|
||||
|
||||
You can ask general questions and get community support through the Docker Community Forums - https://forums.docker.com/ and Slack - http://dockr.ly/slack. Personalized support is available through the Docker Pro, Team, and Business subscriptions. See https://www.docker.com/pricing for details.
|
||||
|
||||
-->
|
||||
|
||||
### Problem description
|
||||
|
||||
<!--
|
||||
Briefly describe the problem that you found. A clear title and description helps us understand and address the issue quickly.
|
||||
|
||||
Report only documentation issues here. Report any product issues in the corresponding product repository.
|
||||
|
||||
If you are reporting a broken link issue, let us know how you arrived at the broken link; was it through a page on docs.docker.com, or from an external website?
|
||||
-->
|
||||
|
||||
### Problem location
|
||||
|
||||
<!-- Help us find the problem quickly by choosing one of the following options: -->
|
||||
|
||||
- I saw a problem at the following URL: <Add URL>
|
||||
|
||||
- I couldn't find the information I wanted. I expected to find it near the following URL <Add the URL and briefly describe how we can improve the existing content>
|
||||
|
||||
- Other: <Add details that can help us understand the issue>
|
||||
|
||||
### Project version(s) affected
|
||||
|
||||
<!-- If this problem only affects specific versions of a project (like Docker
|
||||
Engine 20.10, or Docker Desktop 4.2.0), tell us here. The fix may need to take that into account. -->
|
||||
|
||||
### Suggestions for a fix
|
||||
|
||||
<!--If you have specific ideas about how we can fix this issue, let us know. -->
|
||||
|
||||
<!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
|
||||
name: Broken link
|
||||
description: Four-oh-four!
|
||||
title: '[404]: <link text>'
|
||||
labels:
|
||||
- status/triage
|
||||
|
||||
body:
|
||||
- type: input
|
||||
id: location
|
||||
attributes:
|
||||
label: Location
|
||||
description: Where did you find the broken link?
|
||||
placeholder: https://docs.docker.com/
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: target
|
||||
attributes:
|
||||
label: Broken link
|
||||
description: Where does the broken link point to?
|
||||
placeholder: https://docs.docker.com/
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: comment
|
||||
attributes:
|
||||
label: Comment
|
||||
description: Do you have any additional information to share?
|
||||
placeholder: "I think this points to the wrong page..."
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- Name: Slack
|
||||
url: https://dockr.ly/comm-slack
|
||||
about: Ask questions in the Docker Community Slack
|
||||
- name: Moby
|
||||
url: https://github.com/moby/moby
|
||||
about: Bug reports for Docker Engine
|
||||
- name: Docker Desktop for Windows
|
||||
url: https://github.com/docker/for-win
|
||||
about: Bug reports for Docker Desktop for Windows
|
||||
- name: Docker Desktop for Mac
|
||||
url: https://github.com/docker/for-mac
|
||||
about: Bug reports for Docker Desktop for Mac
|
||||
- name: Docker Desktop for Linux
|
||||
url: https://github.com/docker/for-linux
|
||||
about: Bug reports for Docker Desktop for Linux
|
||||
- name: Docker Compose
|
||||
url: https://github.com/docker/compose
|
||||
about: Bug reports for Docker Compose
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
|
||||
name: Docs issue
|
||||
description: Report incorrect or missing content in docs, or a website issue
|
||||
labels:
|
||||
- status/triage
|
||||
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is this a docs issue?
|
||||
description: |
|
||||
Use this issue for reporting issues related to Docker documentation.
|
||||
For product issues, refer to the corresponding product repository.
|
||||
options:
|
||||
- label: My issue is about the documentation content or website
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Type of issue
|
||||
description: What type of problem are you reporting?
|
||||
multiple: false
|
||||
options:
|
||||
- Information is incorrect
|
||||
- I can't find what I'm looking for
|
||||
- There's a problem with the website
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: |
|
||||
Briefly describe the problem that you found.
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: location
|
||||
attributes:
|
||||
label: Location
|
||||
description: Where did you find the problem?
|
||||
placeholder: "https://docs.docker.com/"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Suggestion
|
||||
description: >
|
||||
Let us know if you have specific ideas on how we can fix the issue.
|
||||
Loading…
Reference in New Issue