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
2018-04-05 11:41:25 -07:00
Brian Coca
5ad13d66aa
documented actual precedence ( #38009 )
...
fixes #22025
2018-04-05 11:09:11 -07:00
Christian Fetzer
9cca9a9c10
docs: Document disabling diff on task level ( #37998 )
...
* docs: Document disabling diff on task level
Tasks that deal with secrets may leak sensitive information when
running in Check Mode. This change updates the documentation explaining
that the diff can be deactivated on task level.
The feature was requested in #14860 and got introduced in Ansible 2.4
with #28581 .
* Updated for clarity
2018-04-05 11:08:30 -07:00
Pilou
2a604f6fe6
doc: index_var: fix version added ( #37982 )
...
e9b0a4ccb4
is present since v2.5.0b1
2018-04-05 11:06:14 -07:00
Jonas Meurer
55fd3d62fb
Update porting_guide_2.5.rst ( #37927 )
...
The example regarding `include_*` is a bit unclear. First it seems like the v2.4 and v2.5 examples are the same. So I attempted to make the relevant change in the examples more obvious.
label: docsite_pr
2018-04-05 11:05:38 -07:00
Dag Wieers
cdf9e39647
Fix the automatic docsite_pr label ( #37999 )
2018-04-05 10:48:37 -07:00
Sam Doran
34dca85417
Update installation docs for RHEL based distributions. ( #38056 )
...
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
2018-04-05 10:46:46 -07:00
ewubnhn
ea9ece8e72
Update spelling_word_choice.rst ( #38113 )
...
Added missing format string on "Installer"
label: docsite_pr
2018-04-05 10:45:42 -07:00
Alicia Cozine
24fe8674a6
DOCS: Network Best Practices fixes ( #38293 )
...
* fixes typo per #38217 , corrects link anchor
* adds ssh-agent info per #35649
2018-04-05 10:44:27 -07:00
Scott Butler
62c2b9a544
Removes modules from TOC, speeding up build time and reducing doc disk space requirements.
2018-04-04 20:36:01 -07:00
Toshio Kuratomi
4165bb308b
Fix 2.5 changelog link
2018-04-04 14:39:38 -07:00
Toshio Kuratomi
73c80862c8
Update docs and version definitions for the 2.4.4 and 2.5.0 releases
2018-04-04 14:21:04 -07:00
Dylan Silva
45b5a486c6
2.6 roadmap doc ( #37926 )
...
* 2..6 roadmap doc
* Formatting & network items
* typo
2018-04-04 18:26:19 +01:00
Alicia Cozine
380c074808
demonstrates best practices for group vars ( #37930 )
...
* demonstrates best practices for group vars
* removes vm-specific var from example
* adds brackets to all [group:vars] refs
2018-04-04 09:50:29 -07:00
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. ( #38246 )
2018-04-03 17:13:29 -07:00
Dag Wieers
70d49f7616
Fix indentation issue
...
<!--- Your description here -->
+label: docsite_pr
2018-04-03 10:45:50 +02:00
Sam Doran
b5b3beff83
Correct syntax highlighting in plugin dev docs ( #38184 )
...
Use rst em dash
2018-04-02 15:39:20 -07:00
Daniel
45e4dfda3d
doc: fix grammar ( #38145 )
2018-03-30 18:32:29 +02:00
Alicia Cozine
b72960fdd4
revises network portion of 2.5 porting guide ( #37938 )
...
* revises network portion of 2.5 porting guide
2018-03-27 14:59:04 -05:00
Colin Walters
290cca3613
docs/keywords: Clarify async
a bit ( #37943 )
...
I hastily did a copy/paste of the `async` example and it took me
a while to understand that `async` specified a maximum runtime in seconds.
The docs are actually mostly clear on this, but I made this PR while
reading the code.
This also fixes the spelling of "asynchronously".
2018-03-27 08:15:30 -04:00
Matt Martz
ffbbb5a25b
Use arg_spec type for comparisons on default and choices ( #37741 )
...
* Use arg_spec type for comparisons on default and choices
* Further improve type casting
* Make sure to capture output in more places
* Individually report invalid choices
* Update ignore.txt after resolving merge conflicts
2018-03-26 12:15:32 -05:00
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav ( #37864 )
2018-03-23 17:55:29 -07:00
scottb
47318a50b2
Temporary fix for horizontal scrolling issues on certain pages. Note that this will revert the behavior where headings scroll off the top of the main content region during navigation; fix for that is being investigated. ( #37863 )
2018-03-23 17:36:56 -07:00
Pilou
56d0721bd9
doc: modules involving file transfert bypass pipelining ( #37250 )
...
* doc: modules involving file transfert bypass pipelining
* Fixed typo
2018-03-23 07:02:19 -05:00
Martin Krizek
bcfff1c818
docs: needs_rebase is still used ( #37774 )
2018-03-23 00:51:53 -07:00
Brian Coca
8b45cab3c1
document our deprecation ( #37788 )
...
* document our deprecation
fixes #37779
* Copy edit.
2018-03-22 16:15:02 -04:00
Brian Coca
68e7045a38
try to clarify run_once and forall! ( #37754 )
...
* try to clarify run_once and forall!
* fixed hidden tls middle man
* make when note
* Minor edit
* Typo fix
2018-03-22 09:37:14 -04:00
Brian Coca
40a55e9f55
update vars info ( #37729 )
...
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
2018-03-22 00:02:45 -07:00
Ryan Pineo
fe87869cec
Fix casing on CallbackBase in 2.4 porting guide ( #37616 )
2018-03-22 00:00:23 -07:00
scottb
57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically ( #37661 )
2018-03-20 12:15:15 -07:00
Owen Kuemerle
ba4f26313b
Correct method to get timedelta seconds value ( #37485 )
...
* Correct method to get timedelta seconds value
This also adds additional clarification for extracting different time/date values for time deltas
* Small edit
2018-03-20 12:00:34 -07:00
Brian Coca
64dfaf9cda
removed deffered items ( #37541 )
2018-03-19 01:05:34 -07:00
Michael
7fd74c2089
Fix typo in inventory docs ( #37577 )
2018-03-19 01:04:29 -07:00
scottb
0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. ( #37548 )
2018-03-16 21:35:41 -07:00
Arbab Nazar
775e8ed806
fix the typo
...
<!--- Your description here -->
label: docsite_pr
2018-03-16 16:26:13 -04:00
Dag Wieers
3cc362d958
Add missing YAML escape characters
...
These were missing after review PR #37486
label: docsite_pr
2018-03-15 21:06:16 +01:00
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>
2018-03-15 01:23:34 -07:00
Robert de Bock
0cf2ecbc62
Update porting_guide_2.5.rst
...
A fix to a minor typo. ("Previouslu" -> "Previously")
label: docsite_pr
2018-03-14 17:02:51 -04:00
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
2018-03-14 12:44:21 -07:00
Toshio Kuratomi
fafcb3452f
Porting guide ( #37226 )
...
* Add the lookup plugin strictness to the porting guide
* Edited for clarity.
* Wordsmithing.
2018-03-08 16:02:43 -08:00
Alexander Lex
19f92005b9
Update developing_api.rst ( #37108 )
...
Fix for #17716 and #36110
2018-03-08 10:48:48 +00:00
Pierre-Louis Bonicoli
5d410c2c69
doc: 2.3.3 has been released
...
Sources:
https://github.com/ansible/ansible/releases/tag/v2.3.3.0-1
https://pypi.python.org/pypi/ansible/2.3.3.0
2018-03-07 21:21:56 -05:00
John R Barker
ff28429e2a
Network doc items that are done
2018-03-07 11:37:43 +00:00
Adam Miller
3fd5b0740e
allow ANSIBLE_KEEP_REMOTE_FILES for local test runner ( #33357 )
...
* allow ANSIBLE_KEEP_REMOTE_FILES for local test runner
* add ANSIBLE_KEEP_REMOTE_FILES to tox.ini, update docs
* Clarify handling of environment variables.
2018-03-06 16:28:06 -08:00
Dag Wieers
eb52a88fb6
Improve module docs return values ( #36943 )
...
* Improve module docs return values
Currently the 5 columns shown doesn't make optimal use of the screen
estate, especially for facts modules this is a problem.
* Add returned facts as a separate section
* Remove whitespace and add support section
Since Notes were moved higher up, the Author, Status and Maintainer
information was now placed under the Return Values section.
* Switch Last Updated and Copyright
2018-03-06 10:46:19 +00:00
John R Barker
7a4e270ae0
Link to new network platform pages ( #37057 )
...
Also fix a few broken links
2018-03-06 09:32:26 +00:00
Dag Wieers
bcdaba57b5
Remove Sphinx/Read-the-Docs plug on every doc page ( #37023 )
...
* Remove Sphinx/Read-the-Docs plug on every doc page
No need to have this on every page.
This fixes #37021
* Reinstated RTD credit with revised wording.
* Re-removed RTD footer boilerplate.
2018-03-05 16:14:27 -08:00
Dag Wieers
cb79957b5f
Make use of named links in documentation notes ( #37027 )
...
* Make use of named links in documentation notes
Now that it is possible to name external links, we are making use of
this to make the documentation better.
* Add improvements to ACI documentation
* Disable QA for long line
* Add :menuselection: and :guilabel:
* Improve links on some modules
2018-03-06 00:05:13 +01:00
John R Barker
985f09270d
Ability to link to other pages from plugin docs ( #37009 )
...
Support relative links
2018-03-05 15:16:58 +00:00
scottb
e7f9c5cc60
Copy edits and tweaks
2018-03-02 18:14:07 -05:00