Commit Graph

969 Commits (cd7042857c5ed81223080c51fde1d597a2eeebca)

Author SHA1 Message Date
Toshio Kuratomi 0a7f2093a3 Update info on python support (#38855)
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

  * virtualenv info (previously on the python3 support page)
  * BSD (Link to the working with BSD page)
  * Solaris (Document how to work around the non-POSIX shell on some
    Solaris hosts)

  Fixes #21594

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:

ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

* Make wording for Solaris troubleshooting better.

(cherry picked from commit a08459a814)
7 years ago
Alicia Cozine a2df7ab75e adds FAQ TOC entry, links & examples to modules (#38706)
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples

(cherry picked from commit 0ebc0b9e5a)
7 years ago
scottb 5ec8a19b79 Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501)
(cherry picked from commit 6454aedb44)
7 years ago
Toshio Kuratomi 0e5c66ae72 Fixes for multiline doc descriotions breaking rst formatting
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation

(cherry picked from commit 6ddc64bc7c)
7 years ago
Brian Coca 16f48b539f ensure cli dir exists before saving files to it
(cherry picked from commit 28015d8ae9)
7 years ago
Jonas Meurer 5ea8fa4052 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
(cherry picked from commit 55fd3d62fb)
7 years ago
Toshio Kuratomi d4be7f772a Some more fixes for the docs :ref: disambiguation
The big one is that we needed to set plugin_type when we processed the by_support template.

Also added to list_of_CATEGORY_plugins page (which might not be used)
and corrected a place where I did module_name instead of name_module

(cherry picked from commit 8cdd75a09f)
7 years ago
Brian Coca 07bb0407ad documented actual precedence (#38009)
fixes #22025
(cherry picked from commit 5ad13d66aa)
7 years ago
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)
7 years ago
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)
7 years ago
Martin Krizek 751ae4f4a9 playbooks_variables.rst: fix facts code-block (#38520)
(cherry picked from commit 5297eac46d)
7 years ago
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)
7 years ago
scottb 893807bfc9 [WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.

(cherry picked from commit c97e508806)
7 years ago
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)
7 years ago
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)
7 years ago
John R Barker f5befa5ab4
Correct formatting (#38874) (#38877)
(cherry picked from commit 3d3781db57)
7 years ago
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)
7 years ago
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)
7 years ago
Alicia Cozine 0fdfb27e0f corrects Junos network_cli example & variables (#38601) (#38705)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
7 years ago
Alicia Cozine e8469a5117
inaugural Network FAQ (#38359) (#38703)
(cherry picked from commit ea99cf3231)
7 years ago
Jordan Borean 5f8812ec23
minor typo fix https://github.com/ansible/ansible/pull/38589 7 years ago
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)
7 years ago
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.
7 years ago
Martin Krizek 28b41f5c83 Update playbooks_loops.rst (#38440) (#38475)
Missing parentheses
+label: docsite_pr

(cherry picked from commit 061ecac3b5)
7 years ago
scottb 57931804ed
Mobile CSS update - adds scrolling inertia (#38443) (#38445) 7 years ago
scottb 2895daacdb
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) (#38434) 7 years ago
Toshio Kuratomi e60c4d4690 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. (#38428)
(cherry picked from commit 62c2b9a544)
7 years ago
scottb 14011dbe2a Additional docs CSS fix for mobile (#38376)
(cherry picked from commit 2381d2207e)
7 years ago
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)
7 years ago
scottb 2b78985ff2 Fixes CSS so docs display properly on mobile (#38373)
(cherry picked from commit 79c5a34b0b)
7 years ago
scottb 604b748295 Reinstated element to fix doc display on mobile devices. (#38246)
(cherry picked from commit 68f81a6799)
7 years ago
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)
7 years ago
John R Barker c97c02e83b
Fix the automatic docsite_pr label (#37999) (#38351)
(cherry picked from commit cdf9e39647)
7 years ago
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)
7 years ago
scottb f629825299 Adds VMWare to TOC; sort scenario guides alphabetically (#38238) 7 years ago
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)
7 years ago
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)
7 years ago
scottb 2604832858 Fixes scrolling issue without breaking header nav (#37864)
(cherry picked from commit 3554e2c2d9)
7 years ago
Matt Davis 4b406de19a pick up missing plugin docs boolean coercion backport 7 years ago
Dag Wieers f237508caa Fix nested parameters in module docs (#37793)
(cherry picked from commit 69c0f96112)
7 years ago
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)
7 years ago
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)
7 years ago
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)
7 years ago
John R Barker 4df0be4b1b stable-2.5 docs in sync with devel (#37214) 7 years ago
John R Barker e6effb32b8
Update developing_api.rst (#37108) (#37178)
Fix for #17716 and #36110
(cherry picked from commit 19f92005b9)
7 years ago
John R Barker c4cb7daa6b
Link to new network platform pages (#37057) (#37058)
Also fix a few broken links
(cherry picked from commit 7a4e270ae0)
7 years ago
John R Barker a50b332768
Support <hr/> in module docs (#37030) (#37031)
(cherry picked from commit 0a2dda2060)
7 years ago
John R Barker 9ac8aa3552
Ability to link to other pages from plugin docs (#37009) (#37014)
Support relative links
(cherry picked from commit 985f09270d)
7 years ago
John R Barker 801b5dcd04
[WIP] Backport/2.5/multiple docs (#36907)
Backport/2.5/multiple docs
7 years ago
John R Barker 617659a33c
Network Platform docs (#36814) (#36899)
* introduces platform docs

(cherry picked from commit 4f63123320)
7 years ago