Skip to content

Commit ee933c6

Browse files
committed
Update docs issue template and add github issues config
1 parent 10dab0a commit ee933c6

File tree

3 files changed

+67
-54
lines changed

3 files changed

+67
-54
lines changed

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Akamai/Linode Customer Support
4+
url: https://www.linode.com/docs/products/platform/get-started/guides/support/#contact-customer-support/
5+
about: For issues with an Akamai/Linode account or resources
6+
- name: Community Questions Forums
7+
url: https://www.linode.com/community/questions/
8+
about: For other cloud computing discussions not related to specific Linode documentation

.github/ISSUE_TEMPLATE/docs-issue.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Docs issue report
2+
description: Report an issue for an article on the Linode documentation site
3+
title: "[Docs issue]: "
4+
labels: ["triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this form to file an issue with an article on [https://www.linode.com/docs/](linode.com/docs).
10+
11+
- If you would prefer to provide a 1-5 star rating for a guide, a feedback form is linked to from the bottom of each article.
12+
- A Disqus form is also available at the bottom of each article to discuss it with other readers.
13+
- For issues with your Akamai/Linode account or resources, please [contact customer support](https://www.linode.com/docs/products/platform/get-started/guides/support/#contact-customer-support).
14+
- For other cloud computing discussions not related to specific Linode documentation, visit the [Community Questions forum](https://www.linode.com/community/questions/).
15+
16+
Thank you for filing your report!
17+
- type: input
18+
id: file
19+
attributes:
20+
label: The source article
21+
description: A link to an article on https://www.linode.com/docs/
22+
placeholder: https://www.linode.com/docs/
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Relevant material from article
29+
description: The text, code samples, commands, from the article that the issue is in reference to
30+
placeholder: Copy and paste relevant content from article here
31+
render: shell
32+
- type: textarea
33+
id: issue-description
34+
attributes:
35+
label: Description of issue
36+
description: A summary of the problem, along with any suggested fixes you may have
37+
placeholder: |
38+
Tell us about any:
39+
- Incorrect or outdated information
40+
- Sample code or commands that produce errors
41+
- Unclear instructions or missing steps
42+
- Typos, spelling errors, or grammar issues
43+
- Other problems not mentioned here
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: category
48+
attributes:
49+
label: Issue category
50+
description: What category best describes the issue?
51+
options:
52+
- Information incorrect or outdated
53+
- Sample code or command produces error
54+
- Unclear instructions or missing steps
55+
- Typo, spelling, or grammar issue
56+
- Other
57+
default: 4
58+
validations:
59+
required: true

.github/ISSUE_TEMPLATE/incorrect-information-code.yml

-54
This file was deleted.

0 commit comments

Comments
 (0)