Commit graph

2533 commits

Author SHA1 Message Date
Sandra McCann
3dcdde996c
fix 2.10 version (#73788) 2021-03-16 15:52:36 -05:00
Alicia Cozine
0d4146cb64
Mention that minor releases end once the next ansible release is made. (#73836) (#73868)
(cherry picked from commit 197e8f5640)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2021-03-11 17:28:15 -06:00
Sandra McCann
1741ba2d67
Docs: Update installation page for package split (#73790) (#73866)
(cherry picked from commit 31932f5fa3)

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2021-03-11 17:25:55 -06:00
Felix Fontein
2cca1c509a
Add note on infoblox inventory script. (#73676) (#73759)
(cherry picked from commit c888705493)
2021-03-11 17:25:34 -06:00
Sandra McCann
0a6004d9ca
add base 2.10 to docs version switcher (#73770) (#73773)
(cherry picked from commit 6514027957)
2021-03-03 14:23:06 -06:00
Alicia Cozine
c86a498a67
Backport of Split Ansible docs from core docs (#73616) (#73637)
* Split Ansible docs from core docs (#73616)

* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build

This solution builds three types of docs:
* ansible-2.10 and earlier: all the docs.  Handle this via `make webdocs
  ANSIBLE_VERSION=2.10`
* ansible-3 and later: a subset of the docs for the ansible package.
  Handle this via `make webdocs ANSIBLE_VERSION=3` (change the
  ANSIBLE_VERSION to match the version being built for.
* ansible-core: a subset of the docs for the ansible-core package.
  Handle this via `make coredocs`.

* `make webdocs` now always builds all the collection docs
*  Use `make coredocs` to limit it to core plugins only
*  The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit ccbfdec334)

* fix CI failures, correct version switcher and makefile logic, set args in all cases, allow 2.10 build

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-03-03 09:42:00 -06:00
Akira Yokochi
67a018b815
fix typo (#73479)
(cherry picked from commit f72dec16ea)
2021-02-07 01:09:28 -06:00
Felix Fontein
dcec0ec806
Make sure to mention collection version for version_added as well. (#73270) (#73280)
(cherry picked from commit 73aa571305)
2021-02-03 09:20:30 -06:00
David Moreau Simard
d7b562b393
add new glossary terms for 2.10 (#71813) (#73293)
* add new terms for 2.10
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

(cherry picked from commit 4aedd1b987)

Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-02-03 09:19:46 -06:00
Felix Fontein
d5acbfd6e3
Remove 'type: complex' from the example, and mention that it should be avoided. (#73171) (#73222)
(cherry picked from commit 270385f949)
2021-02-03 09:18:06 -06:00
Sviatoslav Sydorenko
4488b91699
Fix versionadded syntax @ galaxy user guide (#73350)
(cherry picked from commit 6abeabaff1)
2021-02-02 11:17:13 -06:00
Felix Fontein
25962888ac
Mention that C(...) should be used for inline code. (#73312) (#73374)
(cherry picked from commit 76604397cb)
2021-02-02 11:16:03 -06:00
Sandra McCann
a8ebe99c98 Revert "update the docs requirements versions (#73108) (#73251)"
This reverts commit ee46fe2910.
2021-01-15 14:38:05 -08:00
Sandra McCann
ee46fe2910
update the docs requirements versions (#73108) (#73251)
(cherry picked from commit 0936623901)
2021-01-15 12:45:17 -06:00
Andrew Klychkov
c4adf62220
Docsite: update "Migrating Ansible content to a different collection" info (#72710) (#72849)
* add a reminder about ignore-*.txt entries, fix formatting, add symlink removal note
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
(cherry picked from commit 0a7fcd135c)
2021-01-10 23:24:49 -06:00
Andrew Klychkov
9601d3ef20
Docsite: update complex_data_manipulation and playbooks_advanced_syntax rst files to use FQCNs (#72848) 2021-01-10 23:24:04 -06:00
flowerysong
3df8811ace
Remove inaccurate Vault documentation (#72938) (#72978)
This is not functionality that exists.
(cherry picked from commit 8450858651)
2021-01-08 13:04:51 -06:00
Felix Fontein
4d231a86b7
Rewrite Docker scenario guide (#73069) (#73135)
(cherry picked from commit c9f28c1735)
2021-01-07 15:45:37 -06:00
Abhijeet Kasurde
2246e1a0fb
[2.10] galaxy: Update example for git+file (#73115)
Use correct syntax for installation of role from local git repository. Fixes: #72217

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 776274143f)
2021-01-07 14:12:56 -06:00
Felix Fontein
dc8d0c4d62
Add link to all module and plugin indexes (#72743) (#73099)
* Add link to all module and plugin indexes, use glob setting for toctree.
* Adjust .gitignore
* Fix docs make clean: now that there's a static file in rst/collections, we have to be more
explicit about how we clean the generated files out of that directory.

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
(cherry picked from commit b514200126)
2021-01-07 14:10:52 -06:00
Sandra McCann
6b935947c1
left a stray </div> by mistake (#73132) (#73133)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
(cherry picked from commit 1d8760779c)
2021-01-06 11:35:34 -06:00
Alicia Cozine
26e207d344
remove doc survey banner (#73119) (#73125)
(cherry picked from commit 0a3c5d9dcc)

Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-01-05 16:25:12 -06:00
Sandra McCann
7461f873ef
add docs survey banner (#72907) (#72909)
* add docs survey banner, with date

(cherry picked from commit 6098793315)
2020-12-08 15:46:36 -06:00
Baptiste Mille-Mathias
633396c71b
Update playbooks_filters_ipaddr.rst (#72705) (#72755)
Fix the order of the arguments for ansible.netcommon.reduce_on_network. Pass the network as the argument and the list of IP addresses as the filter input.

(cherry picked from commit 454ac6420e)

Co-authored-by: Pablo Martinez <pablo@docecosas.com>
2020-11-30 15:25:22 -06:00
Felix Fontein
ed78b479ec
Improve argument spec documentation (#72335) (#72486)
* Link to argument spec documentation from 'Creating a module'.

* Use items instead of sub-headings.

* Update deprecation information.

* Document conditional requirements.

* Document supports_check_mode and add_file_common_args.

* Add deprecation examples.

* Re-add word.

* Improve title.

* Fix RST formatting, add conditional dependency section starter.

(cherry picked from commit 01d207a3e3)
2020-11-13 15:17:31 -06:00
Andrew Klychkov
913aebb140
Docsite: update user_guide/playbooks_module_defaults (#72051) (#72493)
* Docsite: update user_guide/playbooks_module_defaults, add name: lines and use FQCN consistently
(cherry picked from commit dbe43e071e)
2020-11-13 14:51:37 -06:00
Felix Fontein
fc4411adcd
Improve config.rst formatting (#72354) (#72487)
* Indent Jinja2 directives.

* Show version_added and deprecations for ini settings and environment variables.

* Make default conditional, add choices. Copied from #55474.

* Add Ansible variables. Copied from #55474.

* Turn ini keys and environment variables into lists. Copied from #55474.

* Improve formatting. Copied from #55474.

(cherry picked from commit 569d937df8)
2020-11-13 14:31:32 -06:00
Felix Fontein
ce47796db9
Add info on how to contribute to **community**-maintained collections as well. (#72494) (#72512)
(cherry picked from commit da1c1e8bb8)
2020-11-06 11:42:18 -06:00
Sandra McCann
31ab3d8a64
clarify upstream release status of 2.10 (#72269) (#72489)
* clarify upstream release status of 2.10

(cherry picked from commit d76f85208d)
2020-11-05 14:34:53 -06:00
Andrew Klychkov
843ebcc436
Docsite: update user_guide/playbooks_async (#72115) (#72193)
(cherry picked from commit 30a651bca3)
2020-10-23 15:29:38 -05:00
Andrew Klychkov
dbbc44b1f4
[2.10] Docsite backport of 71973, 71975, 71980 (#71991)
* Docsite: improve user_guide/playbooks_vars_facts (#71973)

* Docsite: improve user_guide/playbooks_vars_facts

* Docsite: update user_guide/vault (#71975)

* Docsite: update user_guide/playbooks_filters (#71980)
2020-10-23 15:27:03 -05:00
Sandra McCann
b9c8b79d60
remove ansibleFest banner (#72253) (#72266)
(cherry picked from commit 3ece57c01a)
2020-10-23 10:27:35 -05:00
Sandra McCann
5a3a2d1a39
replace porting guides with stub pages - issue 71687 (#71988) 2020-10-21 15:36:40 -05:00
Andrew Klychkov
b8e718cccd
[2.10] Docsite backports of 71938, 71907 (#71972)
* Docsite: improve user_guide/playbooks_variables (#71938)
(cherry picked from commit c19af92be6)

* Docsite: improve inventory-related pages (#71907)
Update docs/docsite/rst/plugins/inventory.rst
(cherry picked from commit 2fed63a930)
2020-10-20 16:03:29 -05:00
Toshio Kuratomi
2e0eb330a1
Update the porting guide for a new ansible version (#72212)
(cherry picked from commit 0a5985c4a6)
2020-10-13 12:37:03 -05:00
Andrew Klychkov
f9ecb4fe74
[2.10] Docsite backport of 72049, 72052, 72053 (#72071)
* Docsite: update user_guide/playbooks_prompts (#72049)

(cherry picked from commit 3efc8b6de8)

* Docsite: update user_guide/playbooks_checkmode (#72052)

(cherry picked from commit c12fce3aa9)

* Docsite: update user_guide/playbooks_debugger (#72053)

(cherry picked from commit 77840f886e)
2020-10-09 10:53:47 -05:00
Baptiste Mille-Mathias
c24bdfa7df
Add example values and results for theory filters (#72087)
(cherry picked from commit 69c3e5644c)
2020-10-09 10:52:16 -05:00
Sloane Hertel
198cffcb52
Fix passing the connection timeout to connection plugins (#71722) (#71785)
(cherry picked from commit 7048542199)
2020-09-28 00:32:04 -05:00
Alicia Cozine
12874bbdea
[2.10] updates intersphinx references for docs links (#71921) (#71945)
* updates intersphinx references for docs links (#71921)

* DOCS: updates intersphinx references for docs links
* TESTS: Raise the number of bytes scanned to determine if a file is binary. The newest ansible-2.10.inv file has its first null byte at position 2261. 4096 is still a cheap chunksize to read so it still makes sense to raise this.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
(cherry picked from commit 27826827e9)

* adds changelog for already-merged PR (#71947)
* adds changelogs/fragments/71921-raise-bytes-for-binary-test.yml

Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit 91b0dfb659)
2020-09-25 13:53:44 -05:00
Andrew Klychkov
5282ab853d
[2.10] Docsite backport 71909, 71859, 71858, 71857, 71854, 71834 (#71937)
* Docsite: improve user_guide/intro_inventory (#71859)

(cherry picked from commit 25bfda8417)

* Docsite: improve user_guide/playbooks_tags (#71858)

(cherry picked from commit c3841b8440)

* Docsite: improve user_guide/playbooks_reuse_roles (#71857)

* Docsite: improve user_guide/playbooks_reuse_roles

* fix
(cherry picked from commit 7a0a2f188b)

* Docsite: update Migrating Ansible content to a different collection (#71854)

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 2655fc0c23)

* Docsite: improve user_guide/intro_adhoc (#71909)

(cherry picked from commit ed6fb2e3f6)

* Docsite: improve user_guide/playbooks_reuse (#71834)

(cherry picked from commit 3db4be2c3b)
2020-09-25 09:42:21 -05:00
Sandra McCann
5fc0dc1956
update install instructions for pip (#71891) (#71922)
(cherry picked from commit e358946b98)
2020-09-24 13:41:14 -05:00
Sandra McCann
77408dccab
fix version label to 2.10 (#71870) 2020-09-22 18:25:52 -05:00
Sandra McCann
a10e76a64c
update version switcher for 2.10 release (#71866)
(cherry picked from commit bf4e102d97)
2020-09-22 14:23:41 -05:00
Sandra McCann
51517a6232
Update the porting guide for a new ansible version (#71863) (#71868)
(cherry picked from commit 606924a4b4)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-09-22 14:20:50 -05:00
Sandra McCann
86de15ea53
add cli parser documentation (#71497) (#71864)
* with native network example, linux example

(cherry picked from commit 0e5911d650)
2020-09-22 14:18:24 -05:00
Sandra McCann
b739bbe0a5
[Docs][backport][2.10] Backportapalooza 12 (#71842)
* Fix typo in the documentation (#71701)

Fix typo in the documentation: casting instead of casing

(cherry picked from commit 1a06587f3b)

* Add how to run unit test link in testing_units_modules doc (#71523)

* Add how to run unit test link in testing_units_modules
* Fix sanity test

(cherry picked from commit 7a0e545700)

* Fix typo in delveloping_plugins_network (#71737)

(cherry picked from commit 4bf61f0714)

* Fix broken bullet list (#71728)

(cherry picked from commit 00ed5b1f2e)

* vmware: Add docs for filters (#71670)

Add a scenario guide for filters in VMware documentation

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

* [docs] add porting guide for DNF GPG validation (#71640)

* [docs] add porting guide for DNF GPG validation

Change:
- This was a breaking change (security fix), but I neglected to add a
  porting guide entry for it previously.

Tickets:
- Refs #71537
- Refs #71539
- Refs #71540
- Refs #71541

Signed-off-by: Rick Elrod <rick@elrod.me>

* changes from sivel

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

* Fixed invalid urls inside guide_packet.rst and collections_using.rst (#71705)

* Fixed invalid urls inside guide_packet.rst and collections_using.rst

* Reverted fix for collections_using.rst

(cherry picked from commit c36e939414)

* Update EXAMPLES in package_facts.py documentation (#71838)

this module is not limited to rpm , so remove rpm in tasks name

(cherry picked from commit 7f62b4733d)

* change duplicated label

(cherry picked from commit bcfead8e0f)

Co-authored-by: Guillaume Vincent <guillaume@oslab.fr>
Co-authored-by: Amin Vakil <info@aminvakil.com>
Co-authored-by: Shufeng <fenghhk@gmail.com>
Co-authored-by: Evaristo Rojas <evaristo.rojas@islas.org.mx>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
Co-authored-by: Shounak <25407872+shounak1@users.noreply.github.com>
Co-authored-by: roumano <roumano@gmail.com>
2020-09-21 15:42:39 -05:00
Andrew Klychkov
47cabb1d32
[2.10] Doc backports: 71753, 71754, 71769, 71770, 71771, 71772 (#71807)
* Docsite: misc fixes of playbooks_delegation (#71753)

(cherry picked from commit 05a45f63ff)

* Docsite: fix playbooks_conditionals (#71754)

(cherry picked from commit aa1f0bd062)

* Docsite: fix user_guide/playbooks_blocks (#71769)

(cherry picked from commit 79dc6fa948)

* Docsite: fix user_guide/playbooks_handlers (#71770)

(cherry picked from commit 1cf42897d2)

* Docsite: fix user_guide/playbooks_error_handling (#71771)

(cherry picked from commit 2c6661d4c1)

* Docsite: fix user_guide/playbooks_environment (#71772)

(cherry picked from commit a204f5f955)
2020-09-21 11:20:57 -05:00
Andrew Klychkov
ea9a223ab6
[2.10] Doc fixes backporting 71697, 71718, 71717 (#71768)
* Docsite: misc fixes (#71697)

(cherry picked from commit a80131a283)

* Docsite: improve playbooks_loops.rst (#71718)

(cherry picked from commit 13ab9f5932)

* Docsite: fix a typo in user_guide/index.rst (#71717)
2020-09-21 10:59:05 -05:00
Sandra McCann
45c8c9909d
[Docs][2.10] Backportapalooza 11 (#71702)
* Add note on where inventory scripts moved to' (#71638)

(cherry picked from commit 2f240f5dd7)

* clarify that collection names use same requirements as namespaces (#71639)

(cherry picked from commit bbd4ec13f1)

* Fix typo in documentation (#71652)

Fix typo on the page about unit testing modules,

(cherry picked from commit 1ad0f666d5)

* Changed all_modules references to list_of_collections in the documentation (#71656)

(cherry picked from commit a34043c6be)

* Adds FAQ and other pointers for collections (#71606)

(cherry picked from commit b430f9b9aa)

* Docs(lineinfile): Update link to python regex docs (#71688)

There was a link still pointing at the python2 documentation.

(cherry picked from commit 11ba30183e)

* Docsite: add reference to Style guide (#71694)

(cherry picked from commit 73bed95ead)

Co-authored-by: Zois Pagoulatos <zpagoulatos@hotmail.com>
Co-authored-by: esmersmith <62951573+esmersmith@users.noreply.github.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Valentin Krasontovitsch <v.krasontov@gmail.com>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
2020-09-10 10:48:28 -05:00
Sandra McCann
57b5069990
Update the porting guide for 2.10.0b2 (#71677) (#71684)
(cherry picked from commit 9fcf1db871)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-09-09 11:38:04 -05:00