Skip to content

Introduce an Issue Report template to be used by docsv3. #886

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

Merged
merged 5 commits into from
Mar 24, 2025
Merged
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
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: "Docs issue"
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
title: "[Issue]: "
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Hi 👋. Thanks for taking the time to fill out this issue report!
This form will create an issue that Elastic's docs team will triage and prioritize.
You can also open a PR instead.
- type: dropdown
attributes:
label: Type of issue
description: What type of issue are you reporting?
multiple: false
options:
- Inaccurate
- Missing information
- I can't find what I'm looking for
- Other
- Other
- type: input
id: link
attributes:
label: What documentation page is affected
description: Include a link to the page where you're seeing the problem.
validations:
required: true
- type: textarea
id: related
attributes:
label: What happened?
description: Describe the issue you're experiencing. Screenshots are valuable too!
validations:
required: true
- type: textarea
id: moreinfo
attributes:
label: Additional info
description: Anything else we should know?
validations:
required: false
Loading