Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding new documentation issue type #508

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Documentation issue
description: File a Documentation issue
title: '[Documentation]: '
labels: ['Documentation']
assignees:
- teakopp
body:
- type: markdown
attributes:
value: |
Describe what Amplify documentation needs additional information or to be otherwise corrected.

Examples of poor documentation include:
* Typos, grammatical errors or nonsensical wording
* Outdated information
* Nonexistent or insufficient examples where appropriate

**If possible, provide a link to the documentation in question.**
- type: textarea
id: what-needs-fixing
attributes:
label: Issue description
placeholder: Describe the issue with the documentation
validations:
required: true