mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
3034709df0
* Improve GitHub templates The existing templates are basically a copy for each type of issue (bug, feature, doc) whereas we can make the template more specific to the task at hand. This PR includes: - More specific sections depending on the type of issue - More concise and direct instructions (NO NEED FOR FRUSTRATION CAPS!) - Single-line comments (no need to guide people to avoid wrong edits) - Improved paste area - Better headings/titles - No 'Summary' title for PRs (so commit information is placed correctly) This PR would require some improvements to Ansibot. * Remove controversial Ansibot stuff Make it easier to get the first batch merged. * Restore ISSUE_TEMPLATE.md * Incorporate reviewer suggestions * Make OS / ENVIRONMENT doc-related * Rephrase Ansibot-related message
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
---
|
|
name: 📝 Documentation Report
|
|
about: Ask us about docs
|
|
---
|
|
<!--- Verify first that your improvement is not already reported on GitHub -->
|
|
<!--- Also test if the latest release and devel branch are affected too -->
|
|
<!--- Complete *all* sections as described, this form is processed automatically -->
|
|
|
|
##### SUMMARY
|
|
<!--- 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 ? -->
|
|
|
|
##### ISSUE TYPE
|
|
- Documentation Report
|
|
|
|
##### COMPONENT NAME
|
|
<!--- Write the name of the rst file, module, plugin, task or feature below -->
|
|
|
|
##### ANSIBLE VERSION
|
|
<!--- Paste verbatim output from "ansible --version" between quotes -->
|
|
```paste below
|
|
|
|
```
|
|
|
|
##### CONFIGURATION
|
|
<!--- Paste verbatim output from "ansible-config dump --only-changed" between quotes -->
|
|
```paste below
|
|
|
|
```
|
|
|
|
##### OS / ENVIRONMENT
|
|
<!--- Provide all relevant information below, e.g. OS version, browser, etc. -->
|
|
|
|
##### ADDITIONAL INFORMATION
|
|
<!--- Describe how this improves the documentation, e.g. before/after situation or screenshots -->
|
|
|
|
<!--- HINT: You can paste gist.github.com links for larger files -->
|