24 Commits (ece31e1b51ce923d4ca3a9f649fd055ab0656ece)

Author	SHA1	Message	Date
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)	5 years ago
Alicia Cozine	43e0aa5b57	WIP: Backport/2.10/71588 (#71626) ... * Add dual index pages for roadmaps (part of #71566) (cherry picked from commit b518a5db14) * Docsite: replace Latin phrases to English (#71588) Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases. * Update docs/docsite/rst/community/committer_guidelines.rst * Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst * Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst * Update docs/docsite/rst/dev_guide/module_lifecycle.rst * Update docs/docsite/rst/user_guide/intro_inventory.rst * Update docs/docsite/rst/user_guide/playbooks_loops.rst * Update docs/docsite/rst/user_guide/playbooks_reuse.rst * Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst * Update docs/docsite/rst/dev_guide/testing.rst * Update docs/docsite/rst/dev_guide/testing_integration.rst * Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst * Update docs/docsite/rst/reference_appendices/faq.rst (cherry picked from commit 7bfeed3e24) * fix index page and TOCs * adds old roadmap index * adds toctree ref for old roadmaps Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>	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
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
Sloane Hertel	34458f3569	Update inventory caching documentation (#69100)	6 years ago
Sloane Hertel	d41050b28b	Add some documentation about plugins in collections (#62465) ... * Add some documentation about using plugins in collections - FQCN requirements - Sharing code in collections - Limitations with inventory caching	6 years ago
Martin Klapproth	dc7a765e57	fix fact caching plugin name from json to jsonfile (#62198)	6 years ago
Jiri Tyr	7efb952825	Adding missing comma (#55254)	7 years ago
Sebastian Gumprich	7239218773	Update inventory.rst (#53656)	7 years ago
Sloane Hertel	9687879840	Fix inventory cache interface (#50446) ... * Replace InventoryFileCacheModule with a better developer-interface Use new interface for inventory plugins with backwards compatibility Auto-update the backing cache-plugin if the cache has changed after parsing the inventory plugin * Update CacheModules to use the config system and add a deprecation warning if they are being imported directly rather than using cache_loader * Fix foreman inventory caching * Add tests * Add integration test to check that fact caching works normally with cache plugins using ansible.constants and inventory caching provides a helpful error for non-compatible cache plugins * Add some developer documentation for inventory and cache plugins * Add user documentation for inventory caching * Add deprecation docs * Apply suggestions from docs review * Add changelog	7 years ago
Felix Fontein	f6122fb63b	Fix docs syntax highlighting errors (#50836) ... * Add support for [WARNING]: ... * Fix unreachable/failed output lexing. * Detecting retry/--limit lines. * Removing strange (invisible) characters which cause lexing problems. * Using better-fitting lexers. * Improve YAML lexing: don't accept quotes in keys. * Add Django lexer (unchanged) from Pygments. * Add support for != and % operators.	7 years ago
Pierre-Louis Bonicoli	7e278b23b4	inventory plugin order: update doc ... add doc for #44428: - add changelog fragment - update porting guide also: - update auto inventory plugin doc - mention toml plugin in examples	7 years ago
Pilou	1bad617f29	Inventory plugins move auto before ini (#44428) ... * inventory plugins: try auto before ini auto plugin should run before ini to avoid ini being able to parse some plugin configuration YAML files successfully. * Update comment comment was added by 2ffe3c42bb but related code was later removed by 506e6a0b2d.	7 years ago
Alicia Cozine	e700309618	Refine plugin docs (#49324) ... * local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages	7 years ago
Matt Martz	45ff6df1af	Remove Deprecated configs 2.8 (#46825) ... * Removed deprecated ANSIBLE_HOSTS * Bump sudo/su configs to match deprecation version for cli and playbook args * Bump include configs to match deprecation version for 'include'	7 years ago
Sloane Hertel	43d12c11be	Add 'auto' to documented default enabled inventory plugins (#46621) ... * Correct default inventory plugins enabled in docs and example/ansible.cfg * Fix headers	7 years ago
Sloane Hertel	33e9d67801	Add some inventory plugin documentation (#44727) ... * Add some additional documentation about getting inventory plugins working using YAML inventory configuration files	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
Brian Coca	475abc0af7	inventory plugin docs (#42022) ... * inventory plugin docs * added set options * minor wording and formatting fixes * changed headers to std as per #35520, also added to main readme * unified inventory plugin devel, referenced from generic plugin dev * fixed typos and update as per feedback	8 years ago
Alicia Cozine	408e29cbd2	Link fixes (#39038) ... * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages	8 years ago
Abhijeet Kasurde	71e85a45c1	Add missing single quote in inventory_plugin doc (#37403) ... Added missing single quote in inventory_plugin doc. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	8 years ago
Brian Coca	2ed46e04f4	more updates to plugin/config generation (#30787) ... * fixed module generation added missing lookup page point to plugins when plugins made modules singular add display for verbose an debug messages nicer templating, changed generation order for ref corrected links moved most of lookup docs to plugin section * Copy edits * Fixed typos * Clarified wording	8 years ago
scottb	6c732bb670	Plugin doc update edits for #30490 (#30889) ... * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490.	8 years ago
Brian Coca	b233f3f296	updated plugin docs (#30490) ... * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page	8 years ago