26 Commits (ece31e1b51ce923d4ca3a9f649fd055ab0656ece)

Author	SHA1	Message	Date
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)	5 years ago
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>	5 years ago
Sandra McCann	d3e0cb4320	[docs][2.10] Backportapalooza 9 (#71493) ... * Explain duplicate checks includes tags and when (#68183) ##### SUMMARY Per #67913, when comparing dependencies, Ansible takes into account parameters, tags and the when clause in determining whether a role is a duplicate or not. ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit 3e4377300b) * Docs: ansible_host can contain FQDN (#71186) (cherry picked from commit 13ab73cd89) * clarify inventory plugin user documentation (#71387) (cherry picked from commit fb035da3b2) * Keep caution tape for older versions (#71400) (cherry picked from commit 156b1c5245) * document securing editor for vault (#71404) (cherry picked from commit 6c48c62f93) * galaxy: Add examples for galaxy section in ansible.cfg (#70931) Add example section for galaxy section in ansible.cfg Fixes: #68402 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 3f3bcbf05e) * docs: Remove examples using the `ec2.py` script (#69107) This script is mostly unmaintained and relies on the deprecated and unmaintained `boto` library. Featuring it prominently in the docs leads to many new users using it instead of the supported `aws_ec2` inventory plugin. (cherry picked from commit 66e38bf499) * Update uri.py (#67688) Adds an example of creating workspaces in Log analytics Azure Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit 4317c2c80c) * docs: Update Kubernetes Guide (#71372) Fixes: #61681 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 59b80b9146) * fix broken links due to master -> main branch rename (#71426) (cherry picked from commit 2b7461eb52) * Modify wording to specify two ctl-d to end stdin input in ansible-vault (#69436) * 51860 - Modify wording to specify two ctl-d to end stdin input in ansible-vault * removes space to make line 160 chars (cherry picked from commit a6537b59ab) * user_guide: Add an example for loop (#71441) Explain how to use complex data in loop while converting from with_together Fixes: #47906 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 5c1594916a) * Add link to Matt's blog (#71436) nitzmahone's blog nicely explained why Windows is not supported as Ansible controller. Link that in documentation so users can read about it. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 3c8744f0c1) * user_guide: Fix reuse role examples (#71440) Fixes: #53919 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 0b16c0a8c7) * service: Add a note about ignored parameters (#71455) Some parameters for systemd are ignored, add a note about such parameters in documentation. Fixes: #23144 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 1257b0a184) * updates network plugin docs pages for 2.10 (#71467) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit f82a1e06d7) * Remove "mode: preserve" option from documentation (#71486) Remove "mode: preserve" option from documentation in doc fragments "FILE_COMMON_ARGUMENTS", as it was incorrectly included in the documentation for the `lineinfile`, `unarchive` and other file-related modules. The `copy` and `templates` modules documentation remains untouched and still contain "mode: preserve", as intended. (cherry picked from commit 7127d37466) * quick update to changelog instructins (#71492) (cherry picked from commit addee0699e) * update Network Advanced Topics for FQCN (#71325) * update Network Advanced Topics for FQCN (cherry picked from commit b6f10b9b52) * fix shippable error Co-authored-by: David M. Lee <leedm777@yahoo.com> Co-authored-by: Eric G <e+github1690@linuxw.info> Co-authored-by: Sloane Hertel <shertel@redhat.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: flowerysong <paul.arthur@flowerysong.com> Co-authored-by: Jose l. Azagra <azagramac@gmail.com> Co-authored-by: Patrick Reader <pxeger@protonmail.com> Co-authored-by: John Westcott IV <32551173+john-westcott-iv@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Timothy Visser <team@sacrome.com>	5 years ago
Sandra McCann	26bb114ccb	[backport][docs][2.10]Docsbackportapalooza 8 (#71379) ... * Move 2.10.0rc1 release date a few days forward. (#71270) At yesterday's meeting it was decided to have ansible-2.10.0 depend on ansible-base-2.10.1 so that we can get several fixes for ansible-base's routing (including adding the gluster.gluster collection). ansible-base-2.10.1 will release on September 8th. So we will plan on releasing ansible-2.10.0rc1 on the 10th. https://meetbot.fedoraproject.org/ansible-community/2020-08-12/ansible_community_meeting.2020-08-12-18.00.html (cherry picked from commit e507c127e5) * a few writing style updates (#71212) (cherry picked from commit 4f0bd5de38) * Fix code markups and add link to CVE (#71082) (cherry picked from commit 92d59a58c0) * Fix 404 links (#71256) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit ecea018506) * Writing style updates to Developing dynamic inventory topic (#71245) * modified the writing style * incorporated peer feedback (cherry picked from commit ecd3b52ad7) * Fix roadmap formatting. (#71275) (cherry picked from commit ee48e0b0ad) * Update password.py (#71295) List md5_crypt, bcrypt, sha256_crypt, sha512_crypt as hash schemes in the password plugin. (cherry picked from commit 1d1de2c6fd) * Update ansible european IRC channel (#71326) Signed-off-by: Rémi VERCHERE <remi@verchere.fr> (cherry picked from commit 824cd4cbeb) * Add warning about copyright year change (#71251) To simplify project administration and avoid any legal issues, add a warning in the docs. This reflects - https://github.com/ansible/ansible/issues/45989#issuecomment-423635622 and fixes: #45989 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 606604bb97) * subelements: Clarify parameter docs (#71177) skip_missing parameter in subelements lookup plugin is accepted from inside the dictionary. Fixes: #38182 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 6d17736ef4) * Writing style updates to Using Variables topic (#71194) * updated topic title, underline length for headings, and incorporated peer feedback (cherry picked from commit 4d68efbe24) * cron module defaults to current user, not root (#71337) (cherry picked from commit 4792d83e13) * Update Network Getting Started for FQCN/collection world (#71188) * pull out network roles, cleanup, update first playbook examples, update gather facts section, some inventory conversion to .yml, update inventory and roles, simplify the navigation titles, fix tocs, feedback comments (cherry picked from commit f79a7c5585) * Add documentation about info/facts module development (#71250) Fixes: #40151 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 4f993922c8) * network: Correct documentation (#71246) ini-style inventory does not support Ansible Vault password. This fixes network_best_practices_2.5 doc. Fixes: #69039 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit a1257d75aa) * tidies up vars page (#71339) (cherry picked from commit 02ea80f6d7) * base.yml: Fix typos (#71346) (cherry picked from commit 41d7d53573) * quick fix to change main back to devel (#71342) * quick fix to change main back to devel * Update docs/docsite/rst/dev_guide/developing_collections.rst Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 74f88c56a5) * Add note about integration tests for new modules to the dev guide (#71345) (cherry picked from commit b82889eef5) * update fest link (#71376) (cherry picked from commit 80b8fde946) * incorporate minimalism feedback on debugging page (#71272) Co-authored-by: bobjohnsrh <50667510+bobjohnsrh@users.noreply.github.com> (cherry picked from commit 5073cfc8bc) * fix header problem Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: rovshango <rovshan.go@gmail.com> Co-authored-by: Remi Verchere <rverchere@users.noreply.github.com> Co-authored-by: Jake Howard <RealOrangeOne@users.noreply.github.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Per Lundberg <perlun@gmail.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>	5 years ago
Sandra McCann	ae9c1167e4	[2.10] Docs Backportapalooza 7 (#71261) ... * Fixes due to branch being renamed (#71115) The ansible collection repository correctly renamed their default branch from `master` to `main`, which has caused a number for broken urls. This PR fixes those urls. (cherry picked from commit fb9c9570d5) * Docs: Fix typo (#71119) (cherry picked from commit cb9336ab6d) * remove network for 2.10 base porting guide (#71158) (cherry picked from commit 56748a8060) * Updating Getting Started with Resources section #68962 (#71102) * Updating Getting Started with Resources section #68962 * Add links, including Workshops URL #68962 (cherry picked from commit 5f8b45a70e) * start of 'data manipulation' examples (#46979) Co-authored-by: Klaus Frank <agowa338@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit f46b124d65) * toml: Clarify about inventory examples (#71180) Add a note in toml inventory plugin about three different inventory examples. Fixes: #67003 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit edac065bd2) * filters: minor doc fix (#71178) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 0a7ab396c7) * docs: 'ansible_play_hosts' lists active hosts, not limited by serial (#71116) ansible_play_batch lists the currently targeted host(s) in the serial/batch, while ansible_play_hosts lists all the hosts which will be targeted by the play. (cherry picked from commit e72e12aa27) * Fix references to Ansible Collections Overview (#71227) (cherry picked from commit 19589db10c) * add another resource module example (#71162) * Update docs/docsite/rst/network/user_guide/network_resource_modules.rst Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com> (cherry picked from commit f4388de14d) * Adds fest link (#71241) (cherry picked from commit ae3b8eec12) * Update release page for ansible and ansible-base (#71229) * [docs] 2.7 is EOL, add 2.10 which is almost out - Remove 2.7 support from the maintenance schedule - Add 2.10 which is in RC and will be out soon enough. Signed-off-by: Rick Elrod <rick@elrod.me> * Update docs/docsite/rst/reference_appendices/release_and_maintenance.rst, fix table and separate ansible-base from ansible, fix rstcheck errors, clean up sections, explain the two packages Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Rick Elrod <rick@elrod.me> (cherry picked from commit 553ccedcd3) Co-authored-by: Daniel Finneran <dan@thebsdbox.co.uk> Co-authored-by: Liviu Chircu <liviu@opensips.org> Co-authored-by: kshitijcode <ikshitijsharma@gmail.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Håkon Solbjørg <hakon@solbj.org> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	5 years ago
Toshio Kuratomi	46b1a999c6	Collections docs generation backport (#70515) ... * Build documentation for Ansible-2.10 (formerly known as ACD). Builds plugin docs from collections whose source is on galaxy The new command downloads collections from galaxy, then finds the plugins inside of them to get the documentation for those plugins. * Update the python syntax checks * docs builds can now require python 3.6+. * Move plugin formatter code out to an external tool, antsibull-docs. Collection owners want to be able to extract docs for their own websites as well. * The jinja2 filters, tests, and other support code have moved to antsibull * Remove document_plugins as that has now been integrated into antsibull-docs * Cleanup and bugfix to other build script code: * The Commands class needed to have its metaclass set for abstractmethod to work correctly * Fix lint issues in some command plugins * Add the docs/docsite/rst/collections to .gitignore as everything in that directory will be generated so we don't want any of it saved in the git repository * gitignore the build dir and remove edit docs link on module pages * Add docs/rst/collections as a directory to remove on make clean * Split the collections docs from the main docs * remove version and edit on github * remove version banner for just collections * clarify examples need collection keyword defined * Remove references to plugin documentation locations that no longer exist. * Perhaps the pages in plugins/*.rst should be deprecated altogether and their content moved? * If not, perhaps we want to rephrase and link into the collection documentation? * Or perhaps we want to link to the plugins which are present in collections/ansible/builtin? * Remove PYTHONPATH from the build-ansible calls One of the design goals of the build-ansible.py script was for it to automatically set its library path to include the checkout of ansible and the library of code to implement itself. Because it automatically includes the checkout of ansible, we don't need to set PYTHONPATH in the Makefile any longer. * Create a command to only build ansible-base plugin docs * When building docs for devel, only build the ansible-base docs for now. This is because antsibull needs support for building a "devel tree" of docs. This can be changed once that is implemented * When building docs for the sanity tests, only build the ansible-base plugin docs for now. Those are the docs which are in this repo so that seems appropriate for now. * Docs: User guide overhaul, part 5 (#70307) (cherry picked from commit db354c0300) * Need to return any error code from running antsibull-docs (#70763) This way we fail early if there's a problem (cherry picked from commit 1e3989c9f7) Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	5 years ago
Sandra McCann	374d4ecd98	Doc backportapalooza 2 (#70440) ... * doc: avoid mix of single and double quotes (#70115) Avoid mix of single and double quotes in the `ternary`, this way we can copy/past the example without any surprise. (cherry picked from commit b491f776b9) * document FQCN for M() and :seealso: in DOCUMENTATION blocks (#70245) * document FQCN for M() in DOCUMENTATION blocks * add note about c (cherry picked from commit 83f6e4850b) * Fix bullet points in intro_getting_started.rst. (#70365) The layout was jumbled due to issues with whitespace. (cherry picked from commit dc6f4b6502) * Add steps for how to create changelog.rst for a collection (#70262) * Update docs/docsite/rst/dev_guide/developing_collections.rst * add steps to create changelogs, add sentence about not using the tool * add note for rerunning the command Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 5a28b2b86c) * ansible-doc: avoid problems with YAML anchors when formatting man page (#70045) * Avoid problems with YAML anchors when formatting man page. * Add changelog. (cherry picked from commit 5e4f708241) * Minor grammatical fix (#70405) 'you' -> 'your' (cherry picked from commit a1ac595d42) * incorporate minimalism feedback on filters page (#70366) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit c89f3cda9e) * more correct info about role main.yml (#70326) fixes #40496 (cherry picked from commit 5d3d097de3) * Fix a small typo in cache plugin description @ `config/base.yml` PR #70420 (cherry picked from commit 626df08d9d) * with_sequence: example using vars (#69369) Added an example for using vars in with_sequence. Fixes: #68836 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 5709173c32) * Update pull.py (#70393) (cherry picked from commit 46ad3c1162) * Update playbooks.rst (#70317) (cherry picked from commit 7c90a2d2a6) * Add documentation for ipaddr filters (#70343) (cherry picked from commit 9eb904ea61) * update platform table with links to collections (#70373) (cherry picked from commit aa59c23aed) * Add description of collections and become_exe keywords (#68055) * Add description of collections keyword * Update based on feedback. - Add link to become plugins. - Add note about how the collections keyword works with roles. (cherry picked from commit 5833af9e2a) Co-authored-by: Gonéri Le Bouder <goneri@lebouder.net> Co-authored-by: Mark Sanders <ziplokk.mark.sanders@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Sir Mobus Gochfulshigan Dorphin Esquire XXIII <celestialtuba@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Michael Scherer <mscherer@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Ethan <smithe2413@gmail.com> Co-authored-by: jafiala <56597272+jafiala@users.noreply.github.com> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Sam Doran <sdoran@redhat.com>	6 years ago
Alicia Cozine	6fffb0607b	WIP: Docs: User guide overhaul, part 4 (#69266) ... Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>	6 years ago
Jonas DOREL	29edcdcf5b	Add library in role directory structure (#67030) ... * Add library directory to the list of directories in a role	6 years ago
Sam Doran	c8568a5c94	Add documentation about vars used in roles at the play level (#66907)	6 years ago
Alicia Cozine	0b503f6057	Docs: User Guide overhaul, part 3 (#66371)	6 years ago
Wojciech Sciesinski	95aef88a45	Update indentation used in the code examples, unify empty lines (#65346)	6 years ago
Alicia Cozine	d4f0bc183e	removes last :doc: links in user guide (#58433) ... * removes last :doc: links in user guide	7 years ago
Evgeni Golov	ace38a2646	two indentation fixes in playbooks_reuse_roles.rst (#51934) ... +label: docsite_pr	7 years ago
branen	88029a73d6	Correct docsite typos: it's -> its (#50812)	7 years ago
Jonas DOREL	d9ae906772	Add galaxy.html#dependencies link (#49984) ... * Add galaxy.html#dependencies link +label: docsite_pr	7 years ago
Tim Burke	6e43f9fe8f	Fix ReST formatting for Galaxy docs link (#49575)	7 years ago
Andreas Krüger	e2bba149d6	playbooks_reuse_roles.rst long and shorthand example actually made equivalent. (#48339)	7 years ago
Brian Coca	44510448b0	prefer ansible_facts namespace and dict notation (#44980) ... * prefer ansible_facts namespace and dict notation * fixed mistranslation	7 years ago
Ritesh Puj	ff654ccfe8	replaced 'ansible_os_platform' to 'ansible_os_family' (#44676) ... replaced 'ansible_os_platform' to 'ansible_os_family' as 'ansible_os_platform' variable is no longer available.	7 years ago
Andreas Olsson	1a11cecaef	Prefer https:// links in the docs site ... All the changed urls are availible by way of https://. Most of them already redirect.	7 years ago
Alexandre Vicenzi	1dafd92c8e	Fix Ansible Galaxy documentation link. (#42316) ... More info: https://github.com/ansible/galaxy/issues/830	8 years ago
Greg DeKoenigsberg	e5ccdaec88	Better Galaxy description for role reuse (#40557) ... * Better Galaxy description for role reuse * update per gundalow review	8 years ago
Brian Coca	c62551c1b0	Update role doc examples (#37844) ... * fix role examples - also fixed issue with overload of 'name', fixes #37836 - attempted to clarify tag inheritance/application * Typo fix	8 years ago
scottb	381359a8f8	Doc build warning/broken link clean-a-palooza (#37382) ... * Doc build warning/broken link clean-a-palooza, WIP commit 1. * Fixed broken anchor * Fixing additional broken links; converting from doc to ref. * Fix anchor	8 years ago
scottb	373b1dcf59	Core Docs Refactor and Redesign (#36067) ... * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable	8 years ago