mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
3.0 KiB
YAML
113 lines
3.0 KiB
YAML
---
|
|
name: 📝 Documentation Report
|
|
description: Ask us about docs
|
|
|
|
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.
|
|
|
|
**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
|
|
|
|
|
|
- type: checkboxes
|
|
attributes:
|
|
label: Code of Conduct
|
|
description: |
|
|
Read the [Ansible Code of Conduct][CoC] first.
|
|
|
|
[CoC]: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--documentation_report.yml
|
|
options:
|
|
- label: I agree to follow the Ansible Code of Conduct
|
|
required: true
|
|
...
|