ansible

Commit Graph

Author	SHA1	Message	Date
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>	4 years ago
Alicia Cozine	6fffb0607b	WIP: Docs: User guide overhaul, part 4 (#69266 ) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>	5 years ago
Alicia Cozine	860cacc54f	Docs: User guide overhaul, part 2 (#65474 )	5 years ago
Andrew Schultz	756ac826fe	Improve ignore_unreachable documentation (#64938 )	5 years ago
Sloane Hertel	09f1c286e0	Add some details to any_errors_fatal documentation (#62029 )	5 years ago
Alicia Cozine	d4f0bc183e	removes last :doc: links in user guide (#58433 ) * removes last :doc: links in user guide	5 years ago
Sayed Anisul Hoque	b9c893ec6f	Updated the section under "Aborting the play" in the Error Handling In Playbooks page (#57705 ) * Updated the section under "Aborting the play" Updated "Aborting the play" section in the Error Handling In Playbooks page. Removed the reference to marking all hosts as failed. +label: docsite_pr * Update docs/docsite/rst/user_guide/playbooks_error_handling.rst Co-Authored-By: Sandra McCann <samccann@redhat.com>	6 years ago
Matthew Davis	7d5ada7161	add doc example of multiline failed_when with OR (#56007 ) * add doc example of multiline failed_when with OR * add variety to multiple OR failed_when doc example	6 years ago
Alicia Cozine	5439eb8bd8	Clarifies how Ansible processes multiple `failed_when` conditions (#55941 ) Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).	6 years ago
Caio Ramos	1de1d081a5	Adding more information about blocks and blocks error handling. (#54429 ) * Adding more information about blocks and blocks error handling. * Update docs/docsite/rst/user_guide/playbooks_error_handling.rst and playbooks_blocks.rst * Removing undefined variables as not rescuable errors. Signed-off-by: Caio Ramos <caioramos97@gmail.com> Signed-off-by: Gabriely Pereira <gabriely.pereira@usp.br> * Apply suggestions from code review Co-Authored-By: caiohsramos <caioramos97@gmail.com>	6 years ago
Abhijeet Kasurde	a45063defe	Update changed_when and failed_when examples (#50411 ) Added examples in playbooks_error_handling doc for handlining multiple conditions in changed_when and failed_when Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	6 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.	6 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	7 years ago

13 Commits (a75b3601d949b4e946848f9c12fce5357cebe6ee)