Commit graph

1818 commits

Author SHA1 Message Date
Sandra McCann
b866036365 add eol banner (#59254)
(cherry picked from commit 00699735e9)
2019-07-30 17:26:21 -07:00
Matt Clay
542aec6166 Minor docs fix for sanity test docs backport. 2019-07-26 11:03:45 -07:00
Matt Clay
dd42aac878 Remove redundant "Sanity Tests »" from page title.
The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant.

(cherry picked from commit b4494fa547)
2019-07-26 10:15:21 -07:00
Tomáš Pospíšek
4782c6b0b8 remove ambiguity: use "my_test" as module name (#59335) (#59519)
Use "my_test" as the sample module name on the developing_modules_general page.

(cherry picked from commit 28b9f71640)
2019-07-25 15:49:03 -05:00
Alicia Cozine
752c40464f
Docs on general precedence (#50201) (#59120)
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
(cherry picked from commit c2469648e4)
2019-07-16 14:10:32 -05:00
Sandra McCann
3d9c2e8c23 Add a banner message to warn when not on latest documentation (#58526) (#58762)
* add banner to versions that are not latest

(cherry picked from commit 35b6345bdc)
2019-07-05 09:35:39 -05:00
Nabeel Al-Saber
480b47d3b2 Add Oracle scenario guide (#58443)
* Create and update docs/docsite/rst/scenario_guides/guide_oracle.rst
2019-06-29 11:14:42 -07:00
Sloane Hertel
cb70656c99 Fix notifying handlers by using an exact match (#55624)
* Fix notifying handlers by using an exact match rather than a string subset if listen is text rather than a list

* Enforce better type checking for listeners

* Share code for validating handler listeners

* Add test for handlers without names

* Add test for templating in handlers

* Add test for include_role

* Add a couple notes about 'listen' for handlers

* changelog

(cherry picked from commit ec1287ca7e)
2019-06-28 09:22:39 -07:00
ndclt
6e2bcc3d8e Coherence between example and text (use of to_native) (#58279) (#58283)
(cherry picked from commit 4376e88849)
2019-06-24 11:57:00 -05:00
Felix Fontein
ad00823266 docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508)
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
(cherry picked from commit 505c99265c)
2019-06-20 11:12:16 -07:00
Sandra McCann
e7551ead6c [backport][2.8] add dropdown version selection to docsite (55655) (#58096)
* cherry-pick f3720c90e0, with correct version
2019-06-19 15:50:50 -05:00
Alicia Cozine
80062dc6be
removes link from 404 content, explains options (#57971) (#58091)
(cherry picked from commit 8dfa376e1c)
2019-06-19 14:17:49 -05:00
Alicia Cozine
64a83a031a
Adds custom 404 with cowsay image (#57422) (#57955)
* Adds custom 404, updates CI reqs, TOC on 404 page links to latest

(cherry picked from commit 5658b2ee3e)
2019-06-17 11:55:03 -05:00
Remon van de Kamp
e07c7688c2 Use correct variable for run_once regardless of batch example (#57077) (#57410)
Changes example to `when: inventory_hostname == ansible_play_hosts_all[0]` to really run run_once regardless of serial.

(cherry picked from commit dea9644d21)
2019-06-10 10:36:43 -05:00
Sviatoslav Sydorenko
d701910bf0 Fix an RST link to the changelog config in docs (#57419) 2019-06-10 09:59:08 -05:00
Ed Costello
819507840f Update links to AWS module guidelines to target the devel docsite since (#57465)
the GUIDELINES.md has been removed from devel on github.
2019-06-07 09:59:58 -05:00
Sandra McCann
9f1bb4e142 [Backport] Roadmap and dates for 2.9 (#57428)
* adds 2.9 roadmap, reversed local TOC order (#56371)
(cherry picked from commit f88b660717)

* 2.9 roadmap dates (#57420)
* add dates to 2.9 roadmap, remove alpha phase
(cherry picked from commit 96693600f9)
2019-06-05 15:48:54 -05:00
Sandra McCann
69696dc83e update docsite breadcrumbs from sphinx_rtd_theme (#57316) (#57423)
* improve breadcrumbs
* get edit on github working again
(cherry picked from commit 3136007032)
2019-06-05 14:58:35 -05:00
Bill Nottingham
9184255340 Adjust assorted terminology and wording around product offerings. (#57242) (#57245)
* Adjust assorted terminology and wording around product offerings. 
(cherry-picked from c493593b4b) 

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
2019-05-31 14:56:35 -05:00
Anatoly Kamchatnov
2128e7c14f Windows FAQ: fix reference
(cherry picked from commit 8bf56642bd)
2019-05-30 11:33:52 -07:00
Sandra McCann
4ef102ae79 Correct repository name to install (#56991) (#57078)
(cherry picked from commit e17434c19f)
2019-05-28 14:33:11 -05:00
Sam Doran
0a40b0ed45 [stable-2.8] Update instructions for running module directly (#56883)
The internals of AnsiballZ changed silghtly
(cherry picked from commit 50b1a66649)

Co-authored-by: Sam Doran <sdoran@redhat.com>
2019-05-24 12:08:49 -07:00
Alicia Cozine
5f67bd5ef9
CLI docs include license not copyright (#56871) (#56874)
(cherry picked from commit fc94d79c47)
2019-05-23 17:18:50 -05:00
Sandra McCann
9ec7cdc4b0 Update RHEL repo for Ansible 2.8 (#56859) (#56868)
(cherry picked from commit 3129fc0b17)
2019-05-23 13:56:45 -05:00
Sandra McCann
48189b95cd Copyright fix for 2018 (#56860) (#56869)
* update copyright in footer

* remove extraneous copyright from cli commands

(cherry picked from commit f9b43a0f68)
2019-05-23 13:55:46 -05:00
Felix Fontein
e63818b7d0 Clarify that GPLv3+ module_utils need core team approval (#56740) (#56759)
* Clarify that GPLv3+ module_utils need core team approval.

* Update docs/docsite/rst/dev_guide/shared_snippets/licensing.txt

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* More 'module_util' -> 'file in module_utils'.

(cherry picked from commit 53ec9c8019)
2019-05-22 14:51:37 -05:00
Felix Fontein
043990bc07 Replace deprecated ansible-container references (#56427) (#56672)
Link to ansible-bender instead of the deprecated ansible-container.

Co-Authored-By: Felix Fontein <felix@fontein.de>
(cherry picked from commit 66bfa27685)
2019-05-20 16:12:17 -05:00
Alicia Cozine
5145effbf6
Move backport guide to 2.8 (#56578) (#56671)
The backport guide should refer to Ansible 2.8 instead of 2.7 as the target branch, since 2.8 is out.

(cherry picked from commit 4742897635)
2019-05-20 16:11:51 -05:00
Felix Fontein
99f450bbcc Clarify documentation on _info vs. _facts modules (#56611) (#56668)
* Clarify documentation on _info vs. _facts modules.

* Expand with examples for facts and non-facts.

(cherry picked from commit abca3f1956)
2019-05-20 15:52:12 -05:00
Toshio Kuratomi
40dbb28189 [stable-2.8] Add compat tojson filter for jinja2 versions missing it (#56596) (#56606)
(cherry picked from commit 3f4a22d)

Co-authored-by: Matt Martz <matt@sivel.net>
2019-05-19 16:22:12 -05:00
Alicia Cozine
d123669a46
Backport/2.8/docs last backports (#56498)
* Update default roles_path documentation (#56320)

(cherry picked from commit c1ebc8d9c2)

* docs: Update scopes value example (#56362): example in GCE guide needs "https://" prefix

(cherry picked from commit 85fa65e5f0)

* [doc] fix example: always trigger the handler (#56384): by default, debug task result isn't changed - add 'changed_when: yes' to trigger handler

(cherry picked from commit b3ab83bc70)

* Update of Ansible 2.8 roadmap (#56436): Remove **if needed** for RC2 & RC3, correct date for RC3

(cherry picked from commit d55823b013)

* add how to create HttpApi plugins for network modules (#54340): in a developer guide for networks

(cherry picked from commit cca365061c)

* [Doc-Release-2.8] fixed broken module links in 2.8 porting guide (#56494)

(cherry picked from commit 635931051b)
2019-05-16 10:19:11 -05:00
Sandra McCann
3a2901e3c6 update release table for 2.8 (#56486) (#56492)
(cherry picked from commit f097dca60d)
2019-05-16 10:11:47 -05:00
Sandra McCann
d0196d0dad changed version to 2.8 (#56487) (#56490)
(cherry picked from commit 4bf134756b)
2019-05-16 10:10:42 -05:00
Sandra McCann
0f749a8443 backport porting guide fix 2019-05-15 14:31:34 -04:00
Alicia Cozine
c05b61777c
Backport/2.8/docs rst omnibus (#56310)
* Update windows_setup.rst (#55535): Wrong protocol and port in command.

(cherry picked from commit 6ea3eca8ff)

* Clarify the two targets of vault encryption, with notes about advantages and drawbacks of each

Co-Authored-By: tacatac <taca@kadisius.eu>
(cherry picked from commit 79198cad7a)

* Improve consistency of loop documentation (#55674)

(cherry picked from commit a5cb47d697)

* Add Microsoft Document URL for WinRM Memory Hotfix (#55680)

Co-Authored-By: hiyokotaisa <thel.vadam2485@gmail.com>
(cherry picked from commit 7b86208fcd)

* Clarify the documentation for `async` and `poll`; describe the behavior when `poll` = 0 and when it does not.

Co-Authored-By: tacatac <taca@kadisius.eu>
(cherry picked from commit dbc64ae64c)

* Add security group info and example to AWS guide (#55783): expand documentation on how to use lookup plugin aws_service_ip_ranges with ec2_group module

(cherry picked from commit bb5059f2c7)

* correct description of modules vs plugins (#55784)

(cherry picked from commit 9d5b5d7ddd)

* Fix var naming (#55795): Make vars match tasks in Google Compute guide.

(cherry picked from commit 943f7334c5)

* Clarifies how Ansible processes multiple `failed_when` conditions (#55941): 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)).

(cherry picked from commit 5439eb8bd8)

* Docs: edits & expands module_utils & search path info in dev guide (#55931)

(cherry picked from commit 8542459b95)

* Add faq note about ssh ServerAliveInterval (#55568)

(cherry picked from commit 76dba7aa4f)

* docsite: correct path, list requirements for testing module docs, etc. (#52008)

* dev_guide: correct path, list requirements, etc.; module HTML docs are in '_build/html/module' subdir

(cherry picked from commit b14f477bee)

* Developer documentation update involving module invocation (#55747)

* Update docs for the 2.7 change to AnsiballZ which invokes modules with one
  less Python interpreter

* Add a section on how module results are returned and on trust between modules, action plugins, and the executor.

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-Authored-By: abadger <a.badger@gmail.com>
(cherry picked from commit edafa71f42)

* add doc example of multiline failed_when with OR (#56007)
* add variety to multiple OR failed_when doc example

(cherry picked from commit 7d5ada7161)

* Note that by default the regex test is identical to match, but can do much more (#50205)

* Note that the regex test behaves like 'match', with default settings

(cherry picked from commit 86e98c5213)

* more info on how vaults work (#56183)

also add warning about what it covers.

(cherry picked from commit 8ff27c4e0c)

* Fix var naming in GCE guide

(cherry picked from commit dae5564e2b)

* dev_guide: Various small updates (#53273)

* Document the clarifications that I usually remark when doing reviews
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst

Co-Authored-By: dagwieers <dag@wieers.com>
(cherry picked from commit eac7f1fb58)

* Lack of "--update" flag in older Ubuntu distros (#56283): when installing on older Ubuntu distributions be aware of the lack of ``-u`` or ``--update`` flag.

(cherry picked from commit dd0b0ae47b)

* should have gone into 52373 (#56306)

(cherry picked from commit 3c8d8b1509)
2019-05-13 08:22:20 -05:00
Alicia Cozine
d69da31ceb
Backport/2.8/docs other (#56318)
* Correct link to Thomas' GitHub account (#55587) from tstringer to trstringer

(cherry picked from commit 158452661a)

* Add changelog fragments for #44811 (#55427)

(cherry picked from commit 7e0603282d)

* Speed up the Sphinx documentation build (#55593)

* speeds up the docs build by changing the navigation collapse setting

(cherry picked from commit 47a440774f)

* Improve rendering of default lists (#56041)

(cherry picked from commit 53ed1bfc49)
2019-05-13 07:27:55 -05:00
Alex Stephen
2e4c1dc3cb GCP Deprecations 2019-04-23 13:49:26 -06:00
Alicia Cozine
564393a5e0
adds better links to tips and pitfalls page (#55458) (#55607)
(cherry picked from commit d7f6493084)
2019-04-22 10:00:33 -05:00
Alicia Cozine
80e4fc47c3
docs/docsite: minor fixes in docs/docsite/README.md (#55356) (#55606)
Added inline markup to important references. Fixed minor spelling error.

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
(cherry picked from commit da1f86a40f)
2019-04-22 10:00:19 -05:00
Alicia Cozine
33ca2d192f
Update set_module_args in unit test docs (#55244) (#55604)
* Update docs/docsite/rst/dev_guide/testing_units_modules.rst
`set_unit_args()` should be imported and used in the unit test documentation. 

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
(cherry picked from commit 521e62aa38)
2019-04-22 09:59:38 -05:00
Alicia Cozine
f5561c65bc
Add example for full path on unit tests (#55243) (#55603)
Docs: adds an example when a full path is needed for unit tests, with module_utils, etc.
(cherry picked from commit a005dcfbbd)
2019-04-22 09:59:21 -05:00
Alicia Cozine
e64ea2a0b1
Removed misleading padding from highlighted results of a search query (#55464) (#55601)
(cherry picked from commit 0330ea616e)
2019-04-22 09:59:07 -05:00
Alicia Cozine
9562217680
include windows server 2019 in supported hosts (#55367) (#55598)
<!--- Your description here -->

+label: docsite_pr

(cherry picked from commit 960df24272)
2019-04-22 09:57:25 -05:00
Alicia Cozine
980e5cbdb4
Docs: adding stub page for module/plugin aliases (#54448) (#55597)
* Adding stub pages for deprecated module/plugin aliases.

(cherry picked from commit 395d471065)
2019-04-22 09:57:09 -05:00
Alicia Cozine
1463fdd02a
Adding missing comma (#55254) (#55541)
(cherry picked from commit 7efb952825)
2019-04-22 09:54:55 -05:00
Alicia Cozine
1f84c4982f
Fewer examples use connection: local in docs (#55133) (#55529)
* Fewer connection: local lines in module examples and scenario guides

The line 'connection: local' is not required. See
./docs/docsite/rst/inventory/implicit_localhost.rst

(cherry picked from commit 04220478da)
2019-04-22 09:50:52 -05:00
Jordan Borean
2a118b4cbd SCP filename validation docs (#55399) (#55489)
* SCP filename validation docs

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* edits to scp FAQ entry

* zeut alors I have missed one

* incorporate jborean feedback

* adds link to bug report

(cherry picked from commit 8542f16fa9)
2019-04-22 09:49:20 -05:00
Alicia Cozine
0131ad25bf
Gce migration docs (#51838) (#55545)
* migration docs for gce, with example playbook

* Update docs/docsite/rst/scenario_guides/guide_gce.rst

Co-Authored-By: rambleraptor <alexstephen@google.com>
(cherry picked from commit 91a664a93e)
2019-04-22 09:38:16 -05:00
Abhijeet Kasurde
3117495d43 [2.8] Update unit testing docs (#55366)
* Updated links
* Updated indentation
* Fixed typos

Fixes: #55242

(cherry picked from commit 3003954415)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-04-16 09:12:57 -05:00
Toshio Kuratomi
65b461b8fe Update the porting guide link to changelog 2019-04-11 11:17:22 -07:00