c936b8b638
* Suggest ansible ad-hoc command while developing module (#70308) If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module. * Update docs/docsite/rst/dev_guide/developing_locally.rst Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit82e5d03bdb) * Update AWS Integration test docmentation (#70454) (cherry picked from commite1ba7dc52a) * Update hacking/shippable docs. The `--all` option downloads more than is needed for analyzing code coverage. (cherry picked from commitfb7740ae3b) * Document that subversion module requires subversion (#70537) (cherry picked from commit64c2cb273f) * update documentation link to python 3 (#70509) update the docs link for strftime on the filters page to point to the python3 docs (cherry picked from commitf7db428375) * Update windows_winrm.rst (#70306) gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation. (cherry picked from commitf4ea43c4a0) * updated requirements file for docs build (#70609) (cherry picked from commit38ccfb4a3e) * Clarify that index_var is 0 indexed (#70548) A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed. Its zero indexed twin has a 0 suffix. ``ansible_loop.index`` The current iteration of the loop. (1 indexed) ``ansible_loop.index0`` The current iteration of the loop. (0 indexed) To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed. (cherry picked from commitc410311f55) * docs: update module development docs (#70594) Update module development docs for flattened modules directory. Fixes: #70261 (at least partially) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit20209c508f) * Doc: fix examples of changelog entries. (#70551) (cherry picked from commitedcd1a1a70) * Document tags are not supported with task meta. (#70590) fixes #70338 (cherry picked from commit40591d5fbb) * docs: update date format in removed_at_date (#70597) removed_at_date requires YYYY-MM-DD format. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit375c6b4ae4) * partial update of community docs to reflect collections transition (#70488) (cherry picked from commitf1f782fc37) Co-authored-by: Michael Ritsema <michaelritsema@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Matt Clay <matt@mystile.com> Co-authored-by: Alan Rominger <arominge@redhat.com> Co-authored-by: FloMiau <37121807+FloMiau@users.noreply.github.com> Co-authored-by: mahadelmi <mahadelmi@cmail.carleton.ca> Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com> Co-authored-by: Karl Goetz <goetzk@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
56 lines
2.9 KiB
ReStructuredText
56 lines
2.9 KiB
ReStructuredText
.. _reporting_bugs_and_features:
|
|
|
|
**************************************
|
|
Reporting bugs and requesting features
|
|
**************************************
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
.. _reporting_bugs:
|
|
|
|
Reporting a bug
|
|
===============
|
|
|
|
Security bugs
|
|
-------------
|
|
|
|
Ansible practices responsible disclosure - if this is a security-related bug, email `security@ansible.com <mailto:security@ansible.com>`_ instead of filing a ticket or posting to any public groups, and you will receive a prompt response.
|
|
|
|
Bugs in ansible-base
|
|
--------------------
|
|
|
|
If you find a bug that affects multiple plugins, a plugin that remained in the ansible/ansible repo, or the overall functioning of Ansible, report it to `github.com/ansible/ansible/issues <https://github.com/ansible/ansible/issues>`_. You need a free GitHub account. Before reporting a bug, use the bug/issue search to see if the issue has already been reported. If you are not sure if something is a bug yet, you can report the behavior on the :ref:`mailing list or IRC first <communication>`.
|
|
|
|
Do not open issues for "how do I do this" type questions. These are great topics for IRC or the mailing list, where things are likely to be more of a discussion.
|
|
|
|
If you find a bug, open the issue yourself to ensure we have a record of it. Do not rely on someone else in the community to file the bug report for you. We have created an issue template, which saves time and helps us help everyone with their issues more quickly. Please fill it out as completely and as accurately as possible:
|
|
|
|
* Include the Ansible version
|
|
* Include any relevant configuration
|
|
* Include the exact commands or tasks you are running
|
|
* Describe the behavior you expected
|
|
* Provide steps to reproduce the bug
|
|
* Use minimal well-reduced and well-commented examples, not your entire production playbook
|
|
* When sharing YAML in playbooks, preserve the formatting by using `code blocks <https://help.github.com/articles/creating-and-highlighting-code-blocks/>`_.
|
|
* Document the behavior you got
|
|
* Include output where possible
|
|
* For multiple-file content, use gist.github.com, which is more durable than pastebin content
|
|
|
|
Bugs in collections
|
|
-------------------
|
|
|
|
Many bugs only affect a single module or plugin. If you find a bug that affects a module or plugin hosted in a collection, file the bug in the repository of the :ref:`collection <collections>`:
|
|
|
|
#. Find the collection on Galaxy.
|
|
#. Click on the Issue Tracker link for that collection.
|
|
#. Follow the contributor guidelines or instructions in the collection repo.
|
|
|
|
If you are not sure whether a bug is in ansible-base or in a collection, you can report the behavior on the :ref:`mailing list or IRC first <communication>`.
|
|
|
|
.. _request_features:
|
|
|
|
Requesting a feature
|
|
====================
|
|
|
|
The best way to get a feature into Ansible is to :ref:`submit a pull request <community_pull_requests>`, either against ansible-base or against a collection. See also :ref:`ansible_collection_merge_requirements`.
|