Commit Graph

1090 Commits (f2db9d59c76e5b80f5e4234a25baaa4a6dac3731)

Author SHA1 Message Date
CsilLAB 521ea56e77 Add details to see decrypted vault value (#37341)
* Improves ansible-vault section of network getting started
7 years ago
Toshio Kuratomi 25523666ce 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
7 years ago
Matt Clay 26fa3adeab Add docs-build sanity test. 7 years ago
Will Thames 4ba29c8bf1 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
7 years ago
Qasim Sarfraz 6d830166e9 Minor typo fix (#38589) 7 years ago
Evgeni Golov 7376a9b946 fix with_<lookup> spelling (#38584)
trivial change ;)

+label: docsite_pr
7 years ago
Alicia Cozine da6d2b5f43 corrects Junos network_cli example & variables (#38601)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
7 years ago
Alicia Cozine ea99cf3231 inaugural Network FAQ (#38359) 7 years ago
Martin Krizek 5297eac46d
playbooks_variables.rst: fix facts code-block (#38520) 7 years ago
Martin Krizek f1e41cbb36
playbooks_intro.rst: remove duplicite playbook (#38521) 7 years ago
scottb 6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501) 7 years ago
alekseyp 061ecac3b5 Update playbooks_loops.rst (#38440)
Missing parentheses
+label: docsite_pr
7 years ago
Pierre Templier 1e0df01980 Small typos in docs (#38371)
* Small typos in docs

* Use same wording as in porting_guide_2.5.rst
7 years ago
Abhijeet Kasurde 8bc7af2e34 Minor typo in installation guide (#38452)
Change subsription-manger to subscription-manager

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
scottb d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 7 years ago
Will Thames a8953fcac4 Add documentation on dict2items (#38375)
dict2items is worth mentioning in the filters and loops pages
(the latter as it's useful to replace `with_dict`)

Update some nearby broken links
7 years ago
scottb 785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 7 years ago
Toshio Kuratomi f1b63f435e 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.
7 years ago
scottb 2381d2207e
Additional docs CSS fix for mobile (#38376) 7 years ago
scottb 79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 7 years ago
Pierre Templier 2340ca7701 Small typos in docs (#38370)
* Small typos in docs

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

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

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

* Formatting & network items

* typo
7 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
7 years ago
scottb 68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 7 years ago
Matt Martz a89d0d0919
Ensure that arguments for sub commands are properly indented (#37992) 7 years ago
Dag Wieers 70d49f7616
Fix indentation issue
<!--- Your description here -->

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

* Fixed typo
7 years ago
Martin Krizek bcfff1c818 docs: needs_rebase is still used (#37774) 7 years ago
Dag Wieers 69c0f96112 Fix nested parameters in module docs (#37793) 7 years ago
Brian Coca 8b45cab3c1
document our deprecation (#37788)
* document our deprecation

fixes #37779

* Copy edit.
7 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
7 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
7 years ago
Ryan Pineo fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 7 years ago
Brian Coca 06b70f1614 Revert "Add a few Jinja2 tests to simplify template (#37514)"
This reverts commit b8e07f0d6e.
7 years ago
Dag Wieers b8e07f0d6e
Add a few Jinja2 tests to simplify template (#37514)
Add list test to simplify template
7 years ago
scottb 57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically (#37661) 7 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
7 years ago
Brian Coca 64dfaf9cda removed deffered items (#37541) 7 years ago
Michael 7fd74c2089 Fix typo in inventory docs (#37577) 7 years ago
scottb 0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 7 years ago
Arbab Nazar 775e8ed806 fix the typo
<!--- Your description here -->

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

 label: docsite_pr
7 years ago
Dag Wieers e691e07646 Fix boolean input and string-type validation 7 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>
7 years ago
Robert de Bock 0cf2ecbc62 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

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

* Edited for clarity.

* Wordsmithing.
7 years ago
Dag Wieers 8f2c87231f Ensure the table spans the complete page width (#37129) 7 years ago
Dag Wieers 6636401246 Improve default values and choices in module docs (#36901)
* Improve default values and choices in module docs

So currently we show defaults and choices in separate columns.

For each parameter we have
- Mostly empty default and choices cells
- A list of choices and a separate default value
- Only a default value

So there's a lot of space being wasted on empty cells.
We can do this better.

* Improve Parameters section

* Add Choices back into column header

* Ensure the tables spans the complete page width
7 years ago
Alexander Lex 19f92005b9 Update developing_api.rst (#37108)
Fix for #17716 and #36110
7 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
7 years ago
John R Barker ff28429e2a
Network doc items that are done 7 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.
7 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
7 years ago
John R Barker 7a4e270ae0
Link to new network platform pages (#37057)
Also fix a few broken links
7 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.
7 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
7 years ago
John R Barker 0a2dda2060
Support <hr/> in module docs (#37030) 7 years ago
John R Barker 985f09270d
Ability to link to other pages from plugin docs (#37009)
Support relative links
7 years ago
scottb e7f9c5cc60 Copy edits and tweaks 7 years ago
Brian Coca cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
7 years ago
Dag Wieers 6601e78dfa
Wrong syntax 7 years ago
scottb f923299fe8
Adds the ability to override the doc build output directory from the command line. (#36604)
* Adds the ability to override the doc build output from the command line.

* For safety, removed straight rm of BUILDDIR and removed subdirectories instead.

* Added check to see if BUILDDIR was defined to main makefile
7 years ago
Russ Starr 4a6758b74f Update playbooks_filters_ipaddr.rst (#36883)
Fixed a typo since the example should be referencing the newly defined list.
7 years ago
Alicia Cozine 4f63123320
Network Platform docs (#36814)
* introduces platform docs
7 years ago
Dag Wieers eae0aa0592 Automatically stuff reference in commit message (#36844)
* Automatically stuff reference in commit message

So we probably want to track which edits were performed through the
Github interface, and this change automatically adds a label to the
commit message.

```yaml
<!--- Your description here -->

+label: docsite_pr
```

Eventually this allows to (on regular basis) list the changes from
documentation readers and process them in a separate process.
7 years ago
Dag Wieers 629278464f Improve contribute-message in document footer (#36841) 7 years ago
Dag Wieers 3b27d723fb Fix indentation of requirements (#36813)
Just discovered that the requirements were indented, whereas all other
lists were not. This makes them stand out for no good reason.
7 years ago
Dag Wieers 38abda544f Improve module docs wrt. required params (#36812)
So I am still not satisfied with how required parameters are being
displayed (before it was yes/no, then it became required/optional, and
only required).

Now it will display in small green 'required' under the parameter name.
This is more convenient, and provides more room for the description.
Especially on smaller screens.
7 years ago
Dag Wieers 974c50a417 Move notes higher up in order (#36815)
So people reading the module documentation usually look for parameters
first, and are interested in examples. However the notes are at the very
end even below the Return Values (the least interesting part).

So this change moves the notes higher up, below parameters, but before
examples so people at least see the notes.
7 years ago
John R Barker 41c066eff9
Fix broken links (#36864) 7 years ago
Daniel Andrei Mincă 8362ddd107 clarify the slicing example (#36842)
As stated by fellow contributors, update the slicing example

Resolves:
Related: #36625
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
7 years ago
John R Barker 3911b9c53a
typo 7 years ago
John R Barker b3c64ecd09
khjh
j
7 years ago
Antonio Quinonez de7692b1c9 Explain what the Ansible Quickstart video does (#36453)
* 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.

* Edit
7 years ago
Dag Wieers 50e989f906 docs: Workaround for non-string values (#36720)
* Workaround for non-string values

So I think the proper fix should go into html_ify, which should convert
any value into a string, rather than expecting strings only.

* My preferred solution
7 years ago
Wolfgang Felbermeier 9c81b5d92b Fix table display width. (#36728) 7 years ago