From 3afa9bd08e5ae381eced173bac8570c43c7e3e55 Mon Sep 17 00:00:00 2001
From: Craig Wright <craig.wright@hashicorp.com>
Date: Wed, 5 Oct 2022 14:45:24 -0700
Subject: [PATCH] Create documentation_issue.yml

Closes https://github.com/hashicorp/terraform/issues/31552.

Adds a new issue form type for documentation issues. Format discussed with docs team.
---
 .../ISSUE_TEMPLATE/documentation_issue.yml    | 83 +++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.yml

diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.yml b/.github/ISSUE_TEMPLATE/documentation_issue.yml
new file mode 100644
index 0000000000..faf2bed6d6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_issue.yml
@@ -0,0 +1,83 @@
+name: Documentation Issue
+description: Report an issue or suggest a change in the documentation.
+labels: ["documentation", "new"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Thank you for opening a documentation change request.
+
+        The [hashicorp/terraform](https://github.com/hashicorp/terraform) `Documentation` issue type is
+        reserved for reports relating to the documentation on [https://www.terraform.io/docs]().
+        This issue type is monitored by the technical writers, it is not
+        monitored by the engineering team so if this issue is related to a problem or request for the
+        functionality of Terraform and you want engineering to take a look, please use the `Bug report`
+        or `Feature Request` issue types instead.
+
+        For general usage questions, please see: https://www.terraform.io/community.html.
+
+  - type: textarea
+    id: tf-version
+    attributes:
+      label: Terraform Version
+      description: Run `terraform version` to show the version, and paste the result below. If you're not using the latest version, please check to see if something related to your request has already been implemented in a later version.
+      render: shell
+      placeholder: ...output of `terraform version`...
+      value:
+    validations:
+      required: true
+
+  - type: textarea
+    id: tf-affected-pages
+    attributes:
+      label: Affected Pages
+      description: |
+          Please use this space to link to the pages relevant to your documentation change request.
+      placeholder:
+      value:
+    validations:
+      required: false
+
+  - type: textarea
+    id: tf-problem
+    attributes:
+      label: What is the docs issue?
+      description: Please let us know what problems you faced using the documentation, or what suggestions you have for us regarding the documentation.
+      placeholder:
+      value:
+    validations:
+      required: true
+
+  - type: textarea
+    id: tf-proposal
+    attributes:
+      label: Proposal
+      description: |
+          Please let us know what documentation changes you think would resolve this issue and where
+          you would expect to find them. Are one or more page headings unclear? Do one or more pages
+          need additional context, examples, or warnings? Do we need a new page or section dedicated
+          to a specific topic?  Your ideas help us understand what you and other users need from our
+          documentation and how we can best improve the content.
+      placeholder:
+      value:
+    validations:
+      required: false
+
+  - type: textarea
+    id: tf-references
+    attributes:
+      label: References
+      description: |
+        Are there any other GitHub issues, whether open or closed, that are related to the problem you've described above or to the suggested solution? If so, please create a list below that mentions each of them. For example:
+        ```
+          - #6017
+        ```
+      placeholder:
+      value:
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        **Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue.