ansible/docs/docsite/rst/user_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
..
shared_snippets Add docs detailing how to convert many with_X style loops to use loop and filters (#40964) 2018-06-01 10:37:21 -04:00
basic_concepts.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
become.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
collections_using.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
command_line_tools.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
connection_details.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
guide_rolling_upgrade.rst Remove reference to core Ansible (#68462) 2020-03-26 15:22:36 -04:00
index.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
intro.rst Remove more docs build errors (#45364) 2018-09-11 17:51:47 +01:00
intro_adhoc.rst user_guide/intro_adhoc.rst: fix typo (#67644) 2020-02-21 10:56:25 +00:00
intro_bsd.rst Clarification for Ansible and BSD Introduction (#69275) 2020-05-04 16:16:41 -05:00
intro_dynamic_inventory.rst Redirect inventory script links (#69143) 2020-04-29 16:05:39 -04:00
intro_getting_started.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
intro_inventory.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
intro_patterns.rst Update intro_patterns.rst (#67151) 2020-02-11 11:52:00 -06:00
intro_windows.rst removes last :doc: links in user guide (#58433) 2019-06-26 17:07:27 -04:00
modules.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
modules_intro.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
modules_support.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbook_pathing.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks.rst Doc backportapalooza 2 (#70440) 2020-07-08 16:05:41 -05:00
playbooks_advanced_syntax.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
playbooks_async.rst [backport][2.10] Docsbackportapaloosa (#70302) 2020-06-25 10:17:49 -05:00
playbooks_best_practices.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_blocks.rst Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
playbooks_checkmode.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_conditionals.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_debugger.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_delegation.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_environment.rst note that environment is not good for secrets (#69618) 2020-05-28 15:24:32 -05:00
playbooks_error_handling.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_filters.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
playbooks_filters_ipaddr.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_intro.rst Fix indentation (#66991) 2020-02-03 12:30:12 -05:00
playbooks_lookups.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_loops.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_module_defaults.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_prompts.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
playbooks_python_version.rst Upstream jinja has decided not to rename from jinja2. (#66880) 2020-01-30 10:57:50 -05:00
playbooks_reuse.rst [DOCS] Backportapalooza 5 (#70999) 2020-07-31 15:51:54 -05:00
playbooks_reuse_includes.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_reuse_roles.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_roles.rst removes last :doc: links in user guide (#58433) 2019-06-26 17:07:27 -04:00
playbooks_special_topics.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_startnstep.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_strategies.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_tags.rst all: fix all the the duplicate words (#66784) 2020-01-28 14:06:40 -05:00
playbooks_templating.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_tests.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
playbooks_variables.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
playbooks_vars_facts.rst Docs [2.10] Backportapalooza 6 (#71129) 2020-08-07 16:04:19 -05:00
playbooks_vault.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
plugin_filtering_config.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
quickstart.rst link from quickstart page to Network Getting Started (#65150) 2019-11-21 11:42:57 -05:00
sample_setup.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
vault.rst Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
windows.rst Windows Setup doc; offer 10x perf improvement (#58259) 2019-07-30 15:53:17 -04:00
windows_dsc.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
windows_faq.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
windows_performance.rst Windows Setup doc; offer 10x perf improvement (#58259) 2019-07-30 15:53:17 -04:00
windows_setup.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
windows_usage.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
windows_winrm.rst Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00