cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite/rst/community/reporting_bugs_and_features.rst

57 lines
2.9 KiB
ReStructuredText
Raw Normal View History

Link fixes (#39038) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages
2018-04-20 02:02:30 +02:00
.. _reporting_bugs_and_features:
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review
2017-08-31 21:14:35 +02:00
**************************************
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
Reporting bugs and requesting features
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review
2017-08-31 21:14:35 +02:00
**************************************
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index.
2017-08-02 21:38:29 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
.. contents::
:local:
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review
2017-08-31 21:14:35 +02:00
Docs reorg /community/index & /dev_guide/index (#48734) * Improved community/index.rst makes it easier to find existing content
2018-11-26 20:00:26 +01:00
.. _reporting_bugs:
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task
2018-09-11 18:51:47 +02:00
Reporting a bug
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review
2017-08-31 21:14:35 +02:00
===============
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index.
2017-08-02 21:38:29 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
Security bugs
-------------
Slight Change in Wording in "Reporting Bugs and Features" (#47984) * Adding a link for PR info * Not specifying Google Groups in wording
2018-11-02 19:48:30 +01:00
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.
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index.
2017-08-02 21:38:29 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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>`.
Initial pass at consolidating community content [work in progress] (#27661) * Added placeholder topics for community info * Setup community section index. * Initial move of triage process docs. * Typo/test * Removed triage topic from index.
2017-08-02 21:38:29 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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.
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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:
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
* 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
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
Bugs in collections
-------------------
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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>`:
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
#. Find the collection on Galaxy.
#. Click on the Issue Tracker link for that collection.
#. Follow the contributor guidelines or instructions in the collection repo.
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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>`.
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
Docs reorg /community/index & /dev_guide/index (#48734) * Improved community/index.rst makes it easier to find existing content
2018-11-26 20:00:26 +01:00
.. _request_features:
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
Requesting a feature
Edit pass for relocated community documentation. (#28368) * Edit pass for relocated community documentation. * Updated info on Ansibullbot Fixed improper link syntax Change links to point to new documents Changed Ansibot to Ansibullbot Clarified workflow Change formatting on commans and tags * Update communication.rst Add Contents Use correct headings * Update communication.rst * Topics, remove whitespace, codeofconduct * Formatting * Correct heading * Update maintainers.rst * Minor edits and a request for more info * Removed some hard-to-localize wording. * Removed incomplete sentence * Minor edits per review
2017-08-31 21:14:35 +02:00
====================
New content for bugs and features (#27911) 1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.) 2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 18:31:57 +02:00
partial update of community docs to reflect collections transition (#70488)
2020-07-14 21:47:18 +02:00
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`.
Reference in a new issue Copy permalink