Commit graph

962 commits

Author SHA1 Message Date
Brian Coca
07bb0407ad documented actual precedence (#38009)
fixes #22025
(cherry picked from commit 5ad13d66aa)
2018-04-18 10:02:37 -07:00
Christian Fetzer
529d778015 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

(cherry picked from commit 9cca9a9c10)
2018-04-18 10:01:55 -07:00
Toshio Kuratomi
f670602448 Fix places in docs that refer to modules without namespace
We've namespaced all plugin docs.  Change the docs to reflect that

(cherry picked from commit 9faf7b949e)
2018-04-18 08:48:41 -07:00
Martin Krizek
751ae4f4a9 playbooks_variables.rst: fix facts code-block (#38520)
(cherry picked from commit 5297eac46d)
2018-04-18 08:44:27 -07:00
Toshio Kuratomi
003c52f1ef Modules that have a link to their own deprecated section need to use a different link syntax (#38697)
The :ref: syntax is for linking to targets which are defined for the
whole document tree.  `link`_ is for linking to targets which are inside
of the document.  We want the latter for deprecated sections because
otherwise we'd have to create namespaced link targets for them.

Also fix expansion of version a deprecated module will be removed in
(cherry picked from commit 25523666ce)
2018-04-18 08:28:59 -07:00
scottb
893807bfc9 [WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.

(cherry picked from commit c97e508806)
2018-04-17 18:49:27 -07:00
Toshio Kuratomi
4091ab479f Add alias's as a :ref: target for modules
This is especially important for deprecated modules as we want to link
to those in porting guides and such.

(cherry picked from commit 8f1b5fc47b)
2018-04-17 18:49:20 -07:00
Jordan Borean
9178def456
Fix typo in windows_faq.rst (#38864) (#38916)
Fix typo in `python-pip` packet name.
+label: docsite_pr

(cherry picked from commit 92f4065157)
2018-04-18 08:06:42 +10:00
John R Barker
f5befa5ab4
Correct formatting (#38874) (#38877)
(cherry picked from commit 3d3781db57)
2018-04-17 13:22:43 +01:00
Brian Coca
4d7e174748 centralize doc/config plugin lists (#38775)
* centralize doc/config plugin lists

also update list for generation in docsite
added note to ensure they are in sync

* updated shell page to list plugins

added some more docs hinting at plugins being configurable

* fix edit link for plugins

(cherry picked from commit bdbb89378f)
2018-04-16 13:02:29 -07:00
Alicia Cozine
30d338f664 Add details to see decrypted vault value (#37341) (#38746)
* Improves ansible-vault section of network getting started
(cherry picked from commit 521ea56e77)
2018-04-13 17:54:34 +01:00
Alicia Cozine
0fdfb27e0f corrects Junos network_cli example & variables (#38601) (#38705)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
2018-04-13 16:43:42 +01:00
Alicia Cozine
e8469a5117
inaugural Network FAQ (#38359) (#38703)
(cherry picked from commit ea99cf3231)
2018-04-13 09:00:57 -05:00
Jordan Borean
5f8812ec23
minor typo fix https://github.com/ansible/ansible/pull/38589 2018-04-12 19:06:36 +10:00
Will Thames
86f5a82457
Use a temp directory that is more likely to exist (#38645)
`env:SystemDrive\temp` does not necessarily exist

`env:temp` is much more likely to exist. Use that

(cherry picked from commit 4ba29c8bf1)
2018-04-12 19:02:49 +10:00
Sam Doran
27f2653c7f Update installation docs for RHEL based distributions. (#38053)
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-11 16:28:09 -04:00
Martin Krizek
28b41f5c83 Update playbooks_loops.rst (#38440) (#38475)
Missing parentheses
+label: docsite_pr

(cherry picked from commit 061ecac3b5)
2018-04-09 11:35:04 -07:00
scottb
57931804ed
Mobile CSS update - adds scrolling inertia (#38443) (#38445) 2018-04-07 16:47:31 -07:00
scottb
2895daacdb
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) (#38434) 2018-04-06 23:28:38 -07:00
Toshio Kuratomi
e60c4d4690 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. (#38428)
(cherry picked from commit 62c2b9a544)
2018-04-06 15:12:05 -07:00
scottb
14011dbe2a Additional docs CSS fix for mobile (#38376)
(cherry picked from commit 2381d2207e)
2018-04-06 14:45:53 -07:00
Toshio Kuratomi
32a99acc88 The ssh change note has been removed
Since the note was about 2.0 versus 1.x, this has been removed.  The
file implementing it is gone so we need to stop referencing it.

(cherry picked from commit f1b63f435e)
2018-04-06 12:44:52 -07:00
scottb
2b78985ff2 Fixes CSS so docs display properly on mobile (#38373)
(cherry picked from commit 79c5a34b0b)
2018-04-06 12:42:32 -07:00
scottb
604b748295 Reinstated element to fix doc display on mobile devices. (#38246)
(cherry picked from commit 68f81a6799)
2018-04-06 12:42:32 -07:00
Alicia Cozine
222c1f1090 DOCS: Network Best Practices fixes (#38293) (#38360)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649

(cherry picked from commit 24fe8674a6)
2018-04-06 14:34:47 +01:00
John R Barker
c97c02e83b
Fix the automatic docsite_pr label (#37999) (#38351)
(cherry picked from commit cdf9e39647)
2018-04-05 19:20:03 +01:00
Alicia Cozine
92562a2ba9 demonstrates best practices for group vars (#37930) (#38287)
* demonstrates best practices for group vars

* removes vm-specific var from example

* adds brackets to all [group:vars] refs

(cherry picked from commit 380c074808)
2018-04-05 13:17:44 +01:00
scottb
f629825299 Adds VMWare to TOC; sort scenario guides alphabetically (#38238) 2018-04-03 13:44:10 -07:00
Sam Doran
f1a060743a Doc build warning/broken link clean-a-palooza (#37382) (#38185)
* 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

(cherry picked from commit 381359a8f8)
2018-04-02 11:53:24 -07:00
Alicia Cozine
617d156eac revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
(cherry picked from commit b72960fdd4)
2018-03-28 08:27:44 -07:00
scottb
2604832858 Fixes scrolling issue without breaking header nav (#37864)
(cherry picked from commit 3554e2c2d9)
2018-03-26 13:08:26 -07:00
Matt Davis
4b406de19a pick up missing plugin docs boolean coercion backport 2018-03-23 05:04:13 -07:00
Dag Wieers
f237508caa Fix nested parameters in module docs (#37793)
(cherry picked from commit 69c0f96112)
2018-03-23 00:00:30 -07:00
Dag Wieers
3b1df95798 Various module doc fixes (#37256)
This PR includes:
- A fix for multiple-choice defaults
- A fix for messed up dictionary samples
- Cleaner defaults when they don't appear part of choices
(cherry picked from commit 80ba7b7402)
2018-03-15 17:58:14 -07:00
Robert de Bock
2f8a851b44 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
(cherry picked from commit 0cf2ecbc62)
2018-03-15 17:55:35 -07:00
Toshio Kuratomi
24d98f9e70 Porting guide (#37226) (#37228)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.

(cherry picked from commit fafcb3452f)
2018-03-08 16:06:34 -08:00
John R Barker
4df0be4b1b stable-2.5 docs in sync with devel (#37214) 2018-03-08 12:04:16 -08:00
John R Barker
e6effb32b8
Update developing_api.rst (#37108) (#37178)
Fix for #17716 and #36110
(cherry picked from commit 19f92005b9)
2018-03-08 10:54:29 +00:00
John R Barker
c4cb7daa6b
Link to new network platform pages (#37057) (#37058)
Also fix a few broken links
(cherry picked from commit 7a4e270ae0)
2018-03-06 09:34:40 +00:00
John R Barker
a50b332768
Support <hr/> in module docs (#37030) (#37031)
(cherry picked from commit 0a2dda2060)
2018-03-05 19:20:37 +00:00
John R Barker
9ac8aa3552
Ability to link to other pages from plugin docs (#37009) (#37014)
Support relative links
(cherry picked from commit 985f09270d)
2018-03-05 15:20:49 +00:00
John R Barker
801b5dcd04
[WIP] Backport/2.5/multiple docs (#36907)
Backport/2.5/multiple docs
2018-03-05 14:40:14 +00:00
John R Barker
617659a33c
Network Platform docs (#36814) (#36899)
* introduces platform docs

(cherry picked from commit 4f63123320)
2018-03-01 11:47:42 +00:00
John R Barker
bfbea05d26
Fix broken links (#36864) (#36866)
(cherry picked from commit 41c066eff9)
2018-02-28 15:56:45 +00:00
John R Barker
f14e0e7ee3
clarify the slicing example (#36842) (#36847)
As stated by fellow contributors, update the slicing example

Resolves:
Related: #36625
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
(cherry picked from commit 8362ddd107)
2018-02-28 13:31:33 +00:00
John R Barker
409193a7dc
Explain what the Ansible Quickstart video does (#36453) (#36793)
* Explain what the Ansible Quickstart video does

Rewrote what video does. The video is really not teaching you how to do the work. It explains why you'd want to use Ansible and shows you what it takes (some sample code) . Video also introduces you to other products in the Ansible ecosystem.

(cherry picked from commit de7692b1c9)
2018-02-27 18:48:13 +00:00
Matt Clay
78cc85fa27 Fix rst link syntax.
(cherry picked from commit 3937082892)
2018-02-26 11:18:38 -08:00
John R Barker
6bf30f65b9
Fix typos (#36671) (#36724)
Fix minor typos
(cherry picked from commit 487ff1fe9b)
2018-02-26 11:27:24 +00:00
John R Barker
3d1c8bc2e1 Network Getting started docs (#36337) (#36597)
* first draft of getting started guide
(cherry picked from commit 51a010a696)
2018-02-22 15:15:11 -08:00
John R Barker
3b1c90cd7c Depreciate aos (#36029) (#36393)
* Deprecate Apstra's aos_* modules

These modules don't work with AOS 2.1 or higher.
They will be replaced non-upstreamed modules
2018-02-19 19:30:12 -08:00