Debian Codegraph @

ansible_collections/vmware/vmware_rest/.github/ISSUE_TEMPLATE/documentation_report.yml

raw
1 ---
2 name: Documentation Report
3 description: Ask us about docs
4 # NOTE: issue body is enabled to allow screenshots
5
6 body:
7 - type: markdown
8 attributes:
9 value: |
10 ⚠
11 Verify first that your issue is not [already reported on GitHub][issue search].
12 Where possible also test if the latest release and main branch are affected too.
13 *Complete **all** sections as described, this form is processed automatically.*
14
15 [issue search]: https://github.com/ansible-collections/vmware.vmware_rest/search?q=is%3Aissue&type=issues
16
17 - type: textarea
18 attributes:
19 label: Summary
20 description: |
21 Explain the problem briefly below, add suggestions to wording or structure.
22
23 **HINT:** Did you know the documentation has an `Edit on GitHub` link on every page?
24 placeholder: >-
25 I was reading the Collection documentation of version X and I'm having
26 problems understanding Y. It would be very helpful if that got
27 rephrased as Z.
28 validations:
29 required: true
30
31 - type: dropdown
32 attributes:
33 label: Issue Type
34 # FIXME: Once GitHub allows defining the default choice, update this
35 options:
36 - Documentation Report
37 validations:
38 required: true
39
40 - type: textarea
41 attributes:
42 # For smaller collections we could use a multi-select and hardcode the list
43 # May generate this list via GitHub action and walking files under https://github.com/ansible-collections/community.general/tree/main/plugins
44 # Select from list, filter as you type (`mysql` would only show the 3 mysql components)
45 # OR freeform - doesn't seem to be supported in adaptivecards
46 label: Component Name
47 description: >-
48 Write the short name of the rst file, module, plugin or task below,
49 *use your best guess if unsure*.
50 placeholder: vcenter_vm_tools, vcenter_vm_info
51 validations:
52 required: true
53
54 - type: textarea
55 attributes:
56 label: Ansible Version
57 description: >-
58 Paste verbatim output from `ansible --version` between
59 tripple backticks.
60 value: |
61 ```console (paste below)
62 $ ansible --version
63
64 ```
65 validations:
66 required: false
67
68 - type: textarea
69 attributes:
70 label: Collection Versions
71 description: >-
72 Paste verbatim output from `ansible-galaxy collection list` between
73 tripple backticks.
74 value: |
75 ```console (paste below)
76 $ ansible-galaxy collection list
77 ```
78 validations:
79 required: false
80
81 - type: textarea
82 attributes:
83 label: Configuration
84 description: >-
85 If this issue has an example piece of YAML that can help to reproduce this problem, please provide it.
86 This can be a piece of YAML from, e.g., an automation, script, scene or configuration.
87
88 Paste verbatim output from `ansible-config dump --only-changed` between quotes
89 value: |
90 ```console (paste below)
91 $ ansible-config dump --only-changed
92
93 ```
94 validations:
95 required: false
96
97 - type: textarea
98 attributes:
99 label: OS / Environment
100 description: >-
101 Provide all relevant information below, e.g. OS version,
102 browser, etc.
103 placeholder: RHEL 8, Firefox etc.
104 validations:
105 required: false
106
107 - type: textarea
108 attributes:
109 label: Additional Information
110 description: |
111 Describe how this improves the documentation, e.g. before/after situation or screenshots.
112
113 **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.
114
115 **HINT:** You can paste https://gist.github.com links for larger files.
116 placeholder: >-
117 When the improvement is applied, it makes it more straightforward
118 to understand X.
119 validations:
120 required: false
121
122 - type: checkboxes
123 attributes:
124 label: Code of Conduct
125 description: |
126 Read the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_form--ansible-collections) first.
127 options:
128 - label: I agree to follow the Ansible Code of Conduct
129 required: true
130 ...