Commit Graph

747 Commits (153c9bd539eeffdd6d395b8840f95d56e3814f27)

Author SHA1 Message Date
Elijah Lynn 95d40bcd0a Update fish setup to use `source` instead of `.` (#33207)
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."

source: https://fishshell.com/docs/current/commands.html#source
6 years ago
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
6 years ago
Brian Coca 5ad13d66aa documented actual precedence (#38009)
fixes #22025
6 years ago
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
6 years ago
Pilou 2a604f6fe6 doc: index_var: fix version added (#37982)
e9b0a4ccb4 is present since v2.5.0b1
6 years ago
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
6 years ago
Dag Wieers cdf9e39647 Fix the automatic docsite_pr label (#37999) 6 years ago
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.
6 years ago
ewubnhn ea9ece8e72 Update spelling_word_choice.rst (#38113)
Added missing format string on "Installer"

 label: docsite_pr
6 years ago
Alicia Cozine 24fe8674a6 DOCS: Network Best Practices fixes (#38293)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649
6 years ago
Scott Butler 62c2b9a544 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. 6 years ago
Toshio Kuratomi 4165bb308b Fix 2.5 changelog link 6 years ago
Toshio Kuratomi 73c80862c8 Update docs and version definitions for the 2.4.4 and 2.5.0 releases 6 years ago
Dylan Silva 45b5a486c6 2.6 roadmap doc (#37926)
* 2..6 roadmap doc

* Formatting & network items

* typo
6 years ago
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
6 years ago
scottb 68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 6 years ago
Dag Wieers 70d49f7616
Fix indentation issue
<!--- Your description here -->

+label: docsite_pr
6 years ago
Sam Doran b5b3beff83 Correct syntax highlighting in plugin dev docs (#38184)
Use rst em dash
6 years ago
Daniel 45e4dfda3d doc: fix grammar (#38145) 6 years ago
Alicia Cozine b72960fdd4
revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
6 years ago
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".
6 years ago
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
6 years ago
scottb 3554e2c2d9
Fixes scrolling issue without breaking header nav (#37864) 6 years ago
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) 6 years ago
Pilou 56d0721bd9 doc: modules involving file transfert bypass pipelining (#37250)
* doc: modules involving file transfert bypass pipelining

* Fixed typo
6 years ago
Martin Krizek bcfff1c818 docs: needs_rebase is still used (#37774) 6 years ago
Brian Coca 8b45cab3c1
document our deprecation (#37788)
* document our deprecation

fixes #37779

* Copy edit.
6 years ago
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
6 years ago
Brian Coca 40a55e9f55 update vars info (#37729)
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
6 years ago
Ryan Pineo fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 6 years ago
scottb 57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically (#37661) 6 years ago
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
6 years ago
Brian Coca 64dfaf9cda removed deffered items (#37541) 6 years ago
Michael 7fd74c2089 Fix typo in inventory docs (#37577) 6 years ago
scottb 0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 6 years ago
Arbab Nazar 775e8ed806 fix the typo
<!--- Your description here -->

 label: docsite_pr
6 years ago
Dag Wieers 3cc362d958
Add missing YAML escape characters
These were missing after review PR #37486

 label: docsite_pr
6 years ago
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>
6 years ago
Robert de Bock 0cf2ecbc62 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
6 years ago
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
6 years ago
Toshio Kuratomi fafcb3452f
Porting guide (#37226)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.
6 years ago
Alexander Lex 19f92005b9 Update developing_api.rst (#37108)
Fix for #17716 and #36110
6 years ago
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
6 years ago
John R Barker ff28429e2a
Network doc items that are done 6 years ago
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.
6 years ago
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
6 years ago
John R Barker 7a4e270ae0
Link to new network platform pages (#37057)
Also fix a few broken links
6 years ago
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.
6 years ago
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
6 years ago
John R Barker 985f09270d
Ability to link to other pages from plugin docs (#37009)
Support relative links
6 years ago