summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/documentation_report.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/documentation_report.yml')
-rw-r--r--.github/ISSUE_TEMPLATE/documentation_report.yml103
1 files changed, 103 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/documentation_report.yml b/.github/ISSUE_TEMPLATE/documentation_report.yml
new file mode 100644
index 0000000000..e508c6700b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_report.yml
@@ -0,0 +1,103 @@
+---
+name: 📝 Documentation Report
+description: Ask us about docs
+# NOTE: issue body is enabled to allow screenshots
+issue_body: true # default: true, adds a classic WSYWIG textarea, if on
+
+body:
+- type: markdown
+ attributes:
+ value: |
+ ⚠
+ Verify first that your issue is not [already reported on GitHub][issue search].
+ Also test if the latest release and devel branch are affected too.
+ *Complete **all** sections as described, this form is processed automatically.*
+
+ [issue search]: https://github.com/ansible/ansible/search?q=is%3Aissue&type=issues
+
+
+- type: textarea
+ attributes:
+ label: Summary
+ description: |
+ Explain the problem briefly below, add suggestions to wording or structure.
+
+ **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
+ placeholder: >-
+ I was reading the ansible-core documentation of version X and I'm having
+ problems understanding Y. It would be very helpful if that got
+ rephrased as Z.
+ validations:
+ required: true
+
+- type: dropdown
+ attributes:
+ label: Issue Type
+ # FIXME: Once GitHub allows defining the default choice, update this
+ options:
+ - Documentation Report
+ validations:
+ required: true
+
+- type: input
+ attributes:
+ label: Component Name
+ description: >-
+ Write the short name of the rst file, module, plugin, task or
+ feature below, *use your best guess if unsure*.
+ placeholder: docs/docsite/rst/dev_guide/debugging.rst
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: Ansible Version
+ description: >-
+ Paste verbatim output from `ansible --version` between
+ tripple backticks.
+ value: |
+ ```console (paste below)
+ $ ansible --version
+
+ ```
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: Configuration
+ description: >-
+ Paste verbatim output from `ansible-config dump --only-changed` between quotes.
+ value: |
+ ```console (paste below)
+ $ ansible-config dump --only-changed
+
+ ```
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: OS / Environment
+ description: >-
+ Provide all relevant information below, e.g. OS version,
+ browser, etc.
+ placeholder: Fedora 33, Firefox etc.
+ validations:
+ required: true
+
+- type: textarea
+ attributes:
+ label: Additional Information
+ description: |
+ Describe how this improves the documentation, e.g. before/after situation or screenshots.
+
+ **Tip:** It's not possible to upload the screenshot via this field directly but you can use the last textarea in this form to attach them.
+
+ **HINT:** You can paste https://gist.github.com links for larger files.
+ placeholder: >-
+ When the improvement is applied, it makes it more straightforward
+ to understand X.
+ validations:
+ required: true
+...