diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..a943b18e386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Akamai/Linode Customer Support + url: https://www.linode.com/docs/products/platform/get-started/guides/support/#contact-customer-support/ + about: For issues with an Akamai/Linode account or resources + - name: Community Questions Forums + url: https://www.linode.com/community/questions/ + about: For other cloud computing discussions not related to specific Linode documentation \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs-issue.yml b/.github/ISSUE_TEMPLATE/docs-issue.yml new file mode 100644 index 00000000000..8c54235e16b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs-issue.yml @@ -0,0 +1,59 @@ +name: Docs issue report +description: Report an issue for an article on the Linode documentation site +title: "[Docs issue]: " +labels: ["triage"] +body: + - type: markdown + attributes: + value: | + Use this form to file an issue with an article on [https://www.linode.com/docs/](linode.com/docs). + + - 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. + - A Disqus form is also available at the bottom of each article to discuss it with other readers. + - 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). + - For other cloud computing discussions not related to specific Linode documentation, visit the [Community Questions forum](https://www.linode.com/community/questions/). + + Thank you for filing your report! + - type: input + id: file + attributes: + label: The source article + description: A link to an article on https://www.linode.com/docs/ + placeholder: https://www.linode.com/docs/ + validations: + required: false + - type: textarea + id: context + attributes: + label: Relevant material from article + description: The text, code samples, commands, from the article that the issue is in reference to + placeholder: Copy and paste relevant content from article here + render: shell + - type: textarea + id: issue-description + attributes: + label: Description of issue + description: A summary of the problem, along with any suggested fixes you may have + placeholder: | + Tell us about any: + - Incorrect or outdated information + - Sample code or commands that produce errors + - Unclear instructions or missing steps + - Typos, spelling errors, or grammar issues + - Other problems not mentioned here + validations: + required: true + - type: dropdown + id: category + attributes: + label: Issue category + description: What category best describes the issue? + options: + - Information incorrect or outdated + - Sample code or command produces error + - Unclear instructions or missing steps + - Typo, spelling, or grammar issue + - Other + default: 4 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/incorrect-information-code.yml b/.github/ISSUE_TEMPLATE/incorrect-information-code.yml deleted file mode 100644 index ce06fb62922..00000000000 --- a/.github/ISSUE_TEMPLATE/incorrect-information-code.yml +++ /dev/null @@ -1,54 +0,0 @@ -name: Incorrect information or code -description: File a report on incorrect information or code -title: "[Incorrect information/code]: " -labels: ["incorrect info", "triage"] -body: - - type: markdown - attributes: - value: | - Thank you for filing this report! - - type: textarea - id: context - attributes: - label: Relevant Context - render: shell - - type: input - id: file - attributes: - label: The Source File - validations: - required: false - - type: textarea - id: issue-description - attributes: - label: Description of incorrect information/code - description: Which information or code needs to be corrected? - placeholder: Tell us what you see! - value: "A bug happened!" - validations: - required: true - - type: textarea - id: proposed-fix - attributes: - label: Your proposed fix for the incorrect information/code (optional) - description: How should the incorrect information/code be fixed? - placeholder: Your proposed fix - value: "" - validations: - required: false - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) - options: - - label: I agree to follow this project's Code of Conduct - required: true \ No newline at end of file