ansible/docs/docsite/rst/dev_guide
Sandra McCann b9a406f890
Docs [2.10] Backportapalooza 6 (#71129)
* Misc typo fixes (#71089)

(cherry picked from commit 504ef607f3)

* Add some documentation for the format of meta/runtime.yml (#71035)

* Document the format of meta/runtime.yml

* Document multiple Ansible versions

Clarify difference between deprecation and tombstone fields

* add note

(cherry picked from commit a9eb8b0488)

* add note to uninstall older versions of ansible for pip (#71023)

* add note to uninstall older versions of ansible for pip

* combine with the other PR

(cherry picked from commit 72d3d44163)

* VMware: Inventory scenario guide for hostnames (#71055)

Added a scenario guide for ``hostnames`` parameter
for vmware_vm_inventory.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 0055673c70)

* Document string tests a bit more (#71049)

- Explain how `regex` differs from `match` and `search`.
- Document `multiline` and `ignorecase`.

Signed-off-by: Rick Elrod <rick@elrod.me>
(cherry picked from commit 701c638757)

* docs: Add a note about package requirements for fact gathering (#70796)

Fixes: #26148

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit a6725d6e2a)

* added note about fakeroot (#71018)

see #70895

(cherry picked from commit 11a31e99e6)

* Update documentation of httpapi's handle_httperror method for clarity (#70991)

(cherry picked from commit a0523e5b8a)

* DOCS: add 2.10 collections roadmap (#70975)

* draft of 2.10 collections roadmap

* incorporates feedback from felixfontein

* gundalow and samccann feedback, fix link

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
(cherry picked from commit 9879da8e23)

* updates changelog types; some updates for easier translation (#71027)

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 4f4436c124)

* Document common return values with examples (#71046)

* adding return value examples
* shift to console code blocks
* cleaning up whitespace and shortening invocation example
* reordering diff section

(cherry picked from commit 864573a38d)

* Update intro_getting_started.rst (#71039)

Added two additional learning resources in the See also: section- forgot closing backticks

(cherry picked from commit 9850915bd6)

* Guide users to use ansible-runner (#71063)

Update the docs to guide users to use `ansible-runner` instead of using Python API directly. In many use cases, executing Ansible playbooks are sufficient. In those use cases, `ansible-runner` is easier and much stable to use comparing with Python API, but there is no mention of it.

(cherry picked from commit 0c855dc70b)

* Porting guides for ansible-base 2.10 and ansible 2.10 (#70891)

* Fix changelog link title.

* Rename Ansible 2.10 and 2.11 porting guides to Ansible-base porting guides.

* Add stub for automatically generated 2.10 porting guide.

* Move things that should not be in the ansible-base porting guide to the ansible porting guide.

* Apply changes to base porting guides.

* Add remark that ansible-base is mainly for developers.

* Ansible Base -> Ansible-base

* Fix link in base porting guide.

* Add generated porting guide.

* Use same header signs as antsibull-changelog's RST builder.

* Update generated porting guide.

(cherry picked from commit 61b36c6f30)

* Update network platform guides with FQCN (#70699)

* fqcn all the docs things!

(cherry picked from commit 54bee7152b)

* Document how to upgrade to ansible with pip (#70768)

Fixes #70348

(cherry picked from commit 5019335660)

* document how to migrate between collections (#70243)

* document how to migrate between collections
* Apply suggestions from code review

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 58145dff9c)

* remove github link from plugins (#70951)

(cherry picked from commit e28b20d729)

* Add latest rc from ansible-base (#70974)

* Add latest rc from ansible-base

(cherry picked from commit d62dffafb3)

* Document to_json will convert to ASCII strings by default (#70954)

... as reported in issue #68702

(cherry picked from commit 8c48366f1c)

* Update the porting guide for ansible-2.10.0a8 (#71141)

(cherry picked from commit 0a9638ce4b)

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Sloane Hertel <shertel@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
Co-authored-by: Brian Coca <bcoca@users.noreply.github.com>
Co-authored-by: Nathaniel Case <ncase@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Terciero <terciero@users.noreply.github.com>
Co-authored-by: Brendon O'Sullivan <49501251+bjosullivan@users.noreply.github.com>
Co-authored-by: EthanHur <ethan0311@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-08-07 16:04:19 -05:00
..
platforms [backport][2.10]Docs backportapalooza3 (#70695) 2020-07-17 13:50:40 -05:00
shared_snippets Clarify that GPLv3+ module_utils need core team approval (#56740) 2019-05-21 15:15:55 -05:00
style_guide [DOCS] Backportapalooza 5 (#70999) 2020-07-31 15:51:54 -05:00
testing/sanity validate ansible-base's and collections runtime.yml (#69742) 2020-06-12 15:34:34 +01:00
debugging.rst [stable-2.10] Update module debugging docs (#70847) (#70972) 2020-07-29 14:33:36 -07:00
developing_api.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
developing_collections.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
developing_core.rst removes last :doc: links in the dev guide (#58417) 2019-06-26 14:59:33 -04:00
developing_inventory.rst Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
developing_locally.rst Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
developing_module_utilities.rst fixed some broken links (#66182) 2020-01-06 10:24:07 -06:00
developing_modules.rst rewrite of the developer guide, part 1 (#45179) 2018-09-07 08:57:36 -05:00
developing_modules_best_practices.rst Sanitize URI module keys with no_log values (#70762) (#70820) 2020-07-22 18:28:24 -07:00
developing_modules_checklist.rst This was changed to python 2.7 but should have remained python 2.6 (#66836) 2020-01-28 09:32:03 -06:00
developing_modules_documenting.rst Doc backportapalooza 2 (#70440) 2020-07-08 16:05:41 -05:00
developing_modules_general.rst [stable-2.10] Update module debugging docs (#70847) (#70972) 2020-07-29 14:33:36 -07:00
developing_modules_general_aci.rst remove build errors including guess (#69711) 2020-05-29 11:56:49 -05:00
developing_modules_general_windows.rst Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
developing_modules_in_groups.rst [backport][2.10]Docs backportapalooza3 (#70695) 2020-07-17 13:50:40 -05:00
developing_plugins.rst Update inventory caching documentation (#69100) 2020-05-05 15:10:57 -05:00
developing_program_flow_modules.rst doc: explain default "required" value for argument_spec (#68678) 2020-04-06 16:07:30 -04:00
developing_python_3.rst Update developing_python_3.rst (#66249) 2020-01-13 15:40:37 -05:00
developing_rebasing.rst Update developing_rebasing.rst (#51650) 2019-02-08 13:29:39 -06:00
index.rst [stable-2.10] Update module debugging docs (#70847) (#70972) 2020-07-29 14:33:36 -07:00
migrating_roles.rst remove build errors including guess (#69711) 2020-05-29 11:56:49 -05:00
module_lifecycle.rst Document the ability to deprecate by date (#69833) 2020-06-11 15:28:24 -05:00
overview_architecture.rst Docs: edits & expands module_utils & search path info in dev guide (#55931) 2019-05-01 07:52:34 -05:00
testing.rst Update testing collections to mention ansible-base versions (#69805) 2020-06-10 16:22:01 -04:00
testing_compile.rst Extend dev guide for collection testing and collection hacking (#68899) 2020-04-15 15:51:19 -05:00
testing_documentation.rst dev_guide: Correct path to ansible-test requirements files (#66626) 2020-01-21 10:16:48 -05:00
testing_httptester.rst removes last :doc: links in the dev guide (#58417) 2019-06-26 14:59:33 -04:00
testing_integration.rst [backport][2.10]Docs backportapalooza3 (#70695) 2020-07-17 13:50:40 -05:00
testing_integration_legacy.rst restores legacy testing file (#46095) 2018-09-25 08:52:47 -04:00
testing_pep8.rst Remove obsolete docs on pep8 sanity test. 2019-08-01 22:34:09 -07:00
testing_running_locally.rst [stable-2.10] Update module debugging docs (#70847) (#70972) 2020-07-29 14:33:36 -07:00
testing_sanity.rst Dev guide: add notes about different image types for integration and unit/sanity tests (#68663) 2020-04-07 09:17:44 -05:00
testing_units.rst Dev guide: add notes about different image types for integration and unit/sanity tests (#68663) 2020-04-07 09:17:44 -05:00
testing_units_modules.rst fixes import paths for ansible unit testing (#65775) 2019-12-16 11:07:26 -06:00
testing_validate-modules.rst validate-modules: fix version_added validation for top-level, fix error codes (#70869) (#70947) 2020-07-29 13:54:45 -07:00