Commit Graph

1515 Commits (abdf46803b3021b184ebcd9ea52bf6772355196a)

Author SHA1 Message Date
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
Brian Coca 7a81d5f11e removed now irrelevant section
fixes #35760
7 years ago
Matt Clay 3937082892 Fix rst link syntax. 7 years ago
Kevin Breit 487ff1fe9b Fix typos (#36671)
Fix minor typos
7 years ago
Dag Wieers 8f6eea50db
More improvements to ACI module docs (#36689)
* More improvements to ACI module docs

* Asorted improvements

* Found 2 more

* Improvements to aci_rest documentation
7 years ago
Dag Wieers 4ff0317f3e
Improve module doc parameter list (#36688)
This PR includes:
- Indentation of Jinja constructs
- Put parameter name in bold
- Title-case table headers
- Show 'required' when parameter is required (not yes/no)
- Left-align all values
7 years ago
Dag Wieers 97fde8c760
ACI: Asorted fixes to documentation (#36681) 7 years ago
Dag Wieers 7cf08e9986
Improve parameter required values and ref fix (#36680)
This PR includes:
- An improvement to the parameter listing, where instead of yes/no, it
  is indicated with required/optional (easier when scrolling through a
  long list of parameters)
- Ensure that module reference, eg. M(foobar) do not include the module
  document title
7 years ago
Dag Wieers e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 7 years ago
Dag Wieers 5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 7 years ago
Dag Wieers 8a040415f9
Fix module references in module docs (#36674) 7 years ago
Dag Wieers 3016bc7351
Asorted docs fixed (#36672)
This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see #36667)
- Add missing delimiter
7 years ago
Dag Wieers ba370b178d
docsite: Add 'Edit on GitHub' for module docs (#36667)
This is something I always wanted, a 'Edit on GitHub' button for module
documentation.

I also removed the additional statement in the footer with instructions
on how to edit the module documentation.

PS The links go directly into the GitHub file editor now !
7 years ago
Dag Wieers fde4cc6219
guide_aci: Fix a few references (#36666) 7 years ago
Brian Ong 1abc47c5d3 Fixed indentation error in `facts-demo.yml` example. (#36645)
* Fixed indentation error in `facts-demo.yml` example.

`content` and `dest` should be indented under the `copy` module.

* Updated indentation of copy module in `facts-demo.yml` example.

Updated indentation of copy module in `facts-demo.yml` to be inline with its name.
7 years ago
Dag Wieers 7da7ba79bc Add anchors to some guides and all module categories (#36642)
* Add anchors to some guides and all module categories

This is required if we want to use *absolute* :ref: references instead of *relative* :doc: references.

* Update the Cisco ACI Guide reference

* Add `aci_guide` anchor

* Add `network_guide` anchor

* Add category anchor

* Improve readability

* Fix small typo
7 years ago
Matt Martz 076ea07bb5
Add instructions for creating backport PRs (#36593)
* Add instructions for creating backport PRs

* Update development_process.rst

simpler workflow

* Update development_process.rst

added origin note

* A few adjustments to clarity, use backport instead of cherry pick in branch name

* Address formatting issue

* fetch isn't a flag

* Fix rst formatting
7 years ago
Daniel Andrei Mincă 62f237f21e fix erroneous example in inventory (#36625)
After initializing a list in both Python2/Python3 with below elements,
I've tested the indexing and realised that the examples provided in the
documentation are erroneous.

As a result, update the examples with correct values in order to avoid
any future confusion.

Resolves:
Related:
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
7 years ago
Alicia Cozine 51a010a696 Network Getting started docs (#36337)
* first draft of getting started guide
7 years ago
Dag Wieers 7435e115e0
ACI: Various changes to module documentation and guide (#36516)
* ACI: Various changes to module documentation and guide

This PR includes:
- We moved the object class information to the notes
- Add version information to guide chapters
- Add generic note to modules with reference to ACI guide
- Reference known issues in aci_rest documentation
- Remove module_utils function docs from modules
- Indicate which parameters are not required for querying all objects
- Added missing RETURN information

* Fix copyright strings

* Remove aci_domain_to_encap_pool.py for v2.5

* More updates

* PEP8 fix

* Improve listings of parameters/return values
7 years ago
Klaas Demter ce80485ecd [Doc] Update Conditional Imports (#35492)
* [Doc] Update Conditional Imports

facter/ohai is not needed for the ansible internal facts
also fix that os_family for centos is redhat

* Copy edit.
7 years ago
Matt Lee 75ab070c63 Update vault.rst (#36328)
hunter2 not hunter42. http://bash.org/?244321
7 years ago
Ganesh Nalawade b57cc7cf31
Update network debug troubleshooting guide (#36288)
* Update network debug troubleshooting guide

Fix #35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.

* Update example error

* Fix CI issues

* Fix more CI failures

* More fixes

* Fix review comments

* Fix more review comments

* Copy edit
7 years ago
Dag Wieers 79d00adc52
aci_rest: Fix error handling and improve documentation (#36295)
This PR includes:
- A fix for a recently introduced issue wrt. error handling
- Added integration tests for provoked errors
- Influence standard return values using aci library for aci_rest
- Add proxy support documentation
- Documentation update related to #34175
7 years ago
John R Barker f77a390131
Depreciate aos (#36029)
* Deprecate Apstra's aos_* modules

These modules don't work with AOS 2.1 or higher.
They will be replaced non-upstreamed modules

* Correct list
7 years ago
Brian Coca 3eff279dd7 updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit
7 years ago
Brian Coca 1f363a6a7c updates to porting guide (#36219)
* updates to porting guide

(cherry picked from commit 7a6d6870d4633ae38a14cc799521b5fc1c0320fd)

* Edits to correct spelling, grammar, and clarify wording.

* Fixed typo
7 years ago
Matt Martz 50adc5409b Add several new doc<->arg_spec checks (#36247)
* Add several new doc<->arg_spec checks. See #18183

* Update ignore.txt for validate-modules
7 years ago
John R Barker 577ff4d949
Add stub porting_guide_2.6.rst (#36190)
* Add stub porting_guide_2.6.rst

* Typo fix
7 years ago
scottb 1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 7 years ago
scottb 391896ca9d
Fixed typo in link. (#36220) 7 years ago
David Newswanger 3f5caf659e added support for --testcase flag in ansible-test (#36134)
* added support for --testcase flag in ansible-test

* fixed command format

* added tab completion

* fixed sanity issues

* added documenation for --testcase

* don't autocomplete when multiple modules are selected
7 years ago
Brian Coca 0cf70a8970
never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit
7 years ago
scottb c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 7 years ago
scottb dc902a5022
Fixes broken nested tables in module docs (#36144) 7 years ago
Brian Coca 28015d8ae9 ensure cli dir exists before saving files to it 7 years ago
Brian Coca 5a0f4f0646 removed gnerated files
@dharmabumstead, probably need a few more of these
7 years ago
Patrick Fink 43eb97ef92 Fix typo in vars.rst (#35098) 7 years ago
scottb c10080bfba
Followup to docs refactor pull request #36067 - fixes gitignore and c… (#36120)
* Followup to docs refactor pull request #36067 - fixes gitignore and cleanup in makefile; removes some generated files; moves a straggler to the appropriate subdirectory.

* Fixed some stragglers

* Removed redundant module entries

* Delete generated RST files.
7 years ago
scottb 373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
7 years ago
John R Barker 480a9c10c9
Consistant headings (#36112) 7 years ago
Dag Wieers a875363e35
ACI docs: Add more links to resources and community (#36101)
This PR includes:
- Adding more resources to each section
- Improving wordings
- Add links to the Ansible ACI community pages
7 years ago
Dag Wieers 218f008dab
ACI docs: Add a section about common error messages (#36088)
Since we pass information directly to ACI, we sometimes get error messages back to the user that require some additional information or context.

This PR includes:
- Changes to the default error output so the error is easier to find
  when searching in e.g. Google
- 3 specific error messages that we have encountered and has confused
  our users before
7 years ago
Matt Davis 5f68892e81
requested status updates/removals of punted items 7 years ago
Rvgate d5ae63c0ea Change wording of Going Further section (#35949)
* Change wording of Going Further section

The original wording was confusing with its non-devel branch part.
Made it much clearer for people to understand what to do.

Also removed the git command for creating branches, I believe a
develop should be aware of how basic git commands work.

* Edited for concision and clarity.

* Typo fix

* Typo fix
7 years ago
John R Barker c3523cdd60
Test against a single transport (#35903)
Network integration tests can use tags to run only a specific transport
7 years ago
Dag Wieers 80e1e0b017
ACI: Assorted set of fixes to docs (#35780)
* Assorted set of fixes

* Cosmetic changes to lists

* Add more information related to connection throttling

* Changes to TOC

* Document return values

* More improvements

* Fix casing in title
7 years ago
tterranigma 3371a93b9e Adds doc for new slice filter (#35904)
* Adds doc for new slice filter

* Fixes example

* Adds empty line

* Moves documentation to other section and removes bad suggestion
7 years ago
Brian Coca 07221d777a
Better document connection: local (#34462)
* Better document connection: local

* Attempt at clear wording.

* Fixed spacing
7 years ago
Brian Coca 297eab5073 move away from bad inline var defs
partial fix for #35714
7 years ago
Martin Krizek 4319947e60
Remove jinja native types from roadmap (#35444) 7 years ago
Ganesh Nalawade 1d068d4af9 Update network section in 2.5 porting guide (#35643)
* Update 2.5 porting guide with network module_utils move
7 years ago
Dag Wieers 67c217398c
Add initial ACI guide (#35364)
* Add initial ACI guide

* Implement all review suggestions
7 years ago
Marc Mercer 6bd4803c80 Fixing syntax for mail callback doc (#35379) 7 years ago
Andrew Gaffney e9b0a4ccb4 Add support for defining index var for task loops 7 years ago
Sam Doran 636ef65099 Fix panos_object docs so they generate properly (#35756)
Change description field to a list rather than folder scalar.

Cleanup formatting and line breaks in README.
7 years ago
Joshua Smith cee5d420de Add examples for OpenBSD hosts. (#35691)
* Add examples for OpenBSD hosts.

* Incorporate changes recommended based on feedback from my pull request.
7 years ago
Tina Müller (tinita) 57d5b8642a Add examples to YAMLSyntax; fix minor issues and improve wording (#35703)
* Add examples to YAMLSyntax; fix minor issues and improve wording

I added proper titles to "Flow Collections" and "Block Scalars", because these
are official YAML Terms, so people can find better help when having issues.

I changed the "ignored newlines" to "folded newlines" because I think ignoring
gives a wrong impression, especially since empty lines (more than one newline)
are not ignored and have a special meaning.

I added an example how to enforce a newline in a folded block scalar.

I fixed the list of characters that are allowed/not allowed in plain and
double quoted scalars.

I added the #yaml channel to the IRC link.

I added links to the YAML Specs. For completeness, I also included YAML 1.2,
although PyYAML and libyaml currently implement 1.1.

* Improve wording

* Add three more characters to forbidden first characters
7 years ago
Matt Martz 975f4def78
Tags on includes only affect the include. FIxes #35729 (#35732) 7 years ago
Joshua Smith 5c2783c161 Update example syntax in playbooks_tests.rst. (#35688) 7 years ago
Joshua Smith f1d0279921 Update example syntax in test_strategies.rst, (#35689) 7 years ago
Ivan Bojer 196f2f382b removed panos_nat_policy (#34432)
* removed panos_nat_policy

* merge

* removed extra line
7 years ago
Joshua Smith e1c9c6eded Update example syntax in playbooks_tags.rst. (#35680) 7 years ago
Joshua Smith 060890f3b2 Update example syntax in playbooks_loops.rst. (#35679) 7 years ago
Joshua Smith aeb749e116 Update example syntax in playbooks_lookups.rst. (#35678) 7 years ago
Joshua Smith 1b7e5d19a2 Update example syntax in playbooks_intro.rst. (#35677) 7 years ago
Joshua Smith 0a5ff792e4 Update example syntax in playbooks_filters.rst. (#35676) 7 years ago
Joshua Smith 6179bd378c Update example syntax in playbooks_error_handling.rst. (#35675) 7 years ago
Joshua Smith 3fe6de475b Update example syntax in playbooks_delegation.rst. (#35674) 7 years ago
Joshua Smith 203c8f4334 Update example syntax in playbooks_conditionals.rst (#35673) 7 years ago
Joshua Smith 6c1a63dd14 Update example syntax (#35670)
* Update examples in guide_rolling_upgrade.rst.

* Update examples playbooks_best_practices.rst.

* Update examples in playbooks_checkmode.rst.
7 years ago
Joshua Smith 7b76da2d4c Update some examples to use proper YAML syntax. (#35640)
* Update some examples to use proper YAML syntax.

* Make the requested changes so this builds properly.

Also fix emphasis line numbers to match what was being emphasized before
the change.
7 years ago
Abhijeet Kasurde d7d9e40dd1
VMware: Deprecate vsphere_guest module (#35648)
This change deprecates vsphere_guest in favor of vmware_guest and other
related modules.

The major reasons behind deprecation are -

- Pysphere - Unofficial Python bindings of vCenter deprecated in the year 2013.
- VMware provides official Python bindings for vCenter, which is used in vmware_guest.
- vcsim - simulator used in integration testing of vmware module does not support PySphere
  APIs, which makes it more difficult to test vsphere_guest.

Please see [deprecation plan](https://github.com/ansible/community/wiki/VMware%3A-vsphere_guest_deprecation)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
jctanner 4ec16867fd Fix loop/with typo in loops doc (#35652) 7 years ago
René Moser 785e888ea0 doc: fix loop examples (#34991) 7 years ago
Ivan Bojer 9ddf8b8ee5 remove panos_security_policy (#34433)
* remove panos_security_policy

* added depreciation notice

* - deprecation notice

* properly document deprecated module

* merge changes

* merge changes

* parser expects srt for deprecations attributes
7 years ago
Mike Cavedon e59d3dd524 Update playbooks_best_practices.rst (#35627)
* Update playbooks_best_practices.rst

If deploying to the first 10 hosts in Boston it should be "-limit boston[0:9]" and the next 10 should be "-limit boston[10:19]". The doc as written would skip the first host (boston[0]) and try to deploy to a host that doesn't exist (boston[20])

* Typo fix
7 years ago
Joshua Smith 0c012703c1 Update developing inventory script docs. (#35639)
* Update developing inventory script docs.

* Copy edit.
7 years ago
Alicia Cozine adf76b7d3f
Reflect new process for network integration tests (#35577)
With `ansible-test network-integration` we don't need the top level yaml files
except NXOS and Dell (for now)
7 years ago
Toshio Kuratomi 0b4debad53 Update the release doc with ansible-2.4.3 7 years ago
Alicia Cozine 9dad5d6b7f creates structure for network docs (#35514) 7 years ago
Abhijeet Kasurde 9d3ba7e36a VMware: Add basic vmware module related guide (#35128)
* VMware: Add basic vmware module related guide

This fix adds page tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Copy edits

* Added module reference

* Edits

* Fixing invalid characters
7 years ago
John R Barker 06734f27c6
Network Doc status (#35475)
Plus remove trailing whitespace
7 years ago
Kylie Liang e497509e51 Update guide_azure.rst to include note about running ansible from within azure (#35441)
* Update guide_azure.rst

Add one more option to run Ansible in Azure

* Minor edit
7 years ago
Matt Martz 3729cc57d0
Add porting guide note about include inheritance change (#35199)
* Add porting guide note about include inheritance change. Fixes #35096

* Also make note of using import_* when possible

* Edited for clarity.
7 years ago
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
7 years ago
Jordan Borean 4da19f2d6b Added code-smell check to verify filenames are allowed with Windows (#35436) 7 years ago
Alessandro Pilotti 1baa9b4d90 Use TEMP variable instead of hardcoded path (#35380)
The script fails if a Temp directory is not present in the system drive (e.g. C:\Temp).
This can be solved by using the TEMP environment variable instead.
7 years ago
Anton Ovchinnikov afc4d3c203 Small documentation fix in vault.rst (#35384) 7 years ago
Dag Wieers 1719267779 Sort arguments and return values in module docs
Comparing the old module docs, with the devel docs the
options/arguments/parameters are no longer sorted.

Also, both in the old module docs and the devel docs the result values
are not sorted where they probably should.
7 years ago
Dag Wieers 73f3b36fb1
Fix modules index delimiter and improve readability (#35187)
* Fix modules index delimiter and improve readability

* Hopefully fixes the links correctly :-/

* Anoteher attempt at this madness
7 years ago
John R Barker 3fadc5d614 Formatting and broken links (#35226) 7 years ago
Matt Clay 7abdab6c9e Convert ansible-test compile into a sanity test. 7 years ago
Matt Clay e0010f15e4 Add pslint sanity test. (#35303)
* Add pslint sanity test.

* Fix `no-smart-quotes` sanity test.

* Add docs for `pslint` sanity test.
7 years ago
John R Barker 181085821b
Clarify when and how to enable ANSIBLE_DEBUG (#35220) 7 years ago
Trishna Guha ba9b5ca048
doc update (#35214)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
7 years ago
Abhijeet Kasurde c0df05c028
github_release: Fix state returned from module (#33735)
This fix corrects the module state returned by github_module.
Now,
* When the release already exists, state is "ok"
* When the release is created, state is "changed"

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Kedar Kekan 5c2f3e3b8c
Update ROADMAP_2_5.rst 7 years ago
Toshio Kuratomi f94fe61b6b Documentation and changelog for the plugin_filtering config option 7 years ago
Aidan Feldman de60328d94 add documentation around commonly-used Facts for Conditionals (#34263)
* add documentation around commonly-used Facts for Conditionals

There are a few Facts that are often used for Conditionals, so
documenting them on the Conditionals page with their possible values.

* Edit
7 years ago
Jordan Borean d0e6889f93 win_become: another option to support become flags for runas (#34551)
* win_become: another option to support become flags for runas

* removed uneeded entries

* fixed up whitespace issue

* Copy edit
7 years ago
Matt Martz 3c400c5899
ANSIBLE_METADATA doesn't support YAML currently, change 315 to invalid data type (#35009) 7 years ago
Matt Martz a352d43824
Compare arg+aliases between docs and argument_spec (#34809)
* compare arg+aliases between docs and argument_spec

* Add some special handling for the network modules provider options that also appear in the top level arg spec

* Fix error code for bigip_hostname

* Address merge conflicts due to changes in f5 modules

* Update validate-modules ignore based off a clean execution

* Address merge conflicts

* Address renamed module

* Address recent changes to modules

* Add ignore for ucs_ip_pool

* Update aci modules to get more reliable documentation comparison, but not mutating the module_utils aci_argument_spec

* Update ignore.txt after recent aci updates

* Add extra guard to ensure we handle provider special only for network modules

* Address additional changes to modules
7 years ago
Nigel Rahkola 2a6156a9d8 Fix syntax error in intro_inventory yaml example (#34960) 7 years ago
Matt Davis 9cf217a151
allow cert validation to be disabled for Azure modules (#34906)
* `validate` or `ignore` values may be set by module, credential profile, or env. Module has highest precedence, followed by credential profile, then environment, and defaults to `validate` if not otherwise specified.
* fixes #33455
7 years ago
Alexander Lex 59042d79f5 Update developing_api.rst to use correct inventory format for single explicit host (#34919)
Fix for #34918
7 years ago
Brian Coca bbd6b8bb42 Temporary (#31677)
* allow shells to have per host options, remote_tmp

added language to shell
removed module lang setting from general as  plugins have it now
use get to avoid bad powershell plugin
more resilient tmp discovery, fall back to `pwd`
add shell to docs
fixed options for when frags are only options
added shell set ops in t_e and fixed option frags
normalize tmp dir usag4e

- pass tmpdir/tmp/temp options as env var to commands, making it default for tempfile
- adjusted ansiballz tmpdir
- default local tempfile usage to the configured local tmp
- set env temp in action

add options to powershell
shift temporary to internal envvar/params
ensure tempdir is set if we pass var
ensure basic and url use expected tempdir
ensure localhost uses local tmp
give /var/tmp priority, less perms issues
more consistent tempfile mgmt for ansiballz
made async_dir configurable
better action handling, allow for finally rm tmp
fixed tmp issue and no more tempdir in ballz
hostvarize world readable and admin users
always set shell tempdir
added comment to discourage use of exception/flow control

* Mostly revert expand_user as it's not quite working.

This was an additional feature anyhow.

Kept the use of pwd as a fallback but moved it to a second ssh
connection.  This is not optimal but getting that to work in a single
ssh connection was part of the problem holding this up.

(cherry picked from commit 395b714120522f15e4c90a346f5e8e8d79213aca)

* fixed script and other action plugins

ensure tmpdir deletion
allow for connections that don't support new options (legacy, 3rd party)
fixed tests
7 years ago
Matt Martz ae49dd65d9 Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance (#34769)
* Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance
7 years ago
jctanner b10d5f34ea Extend validate-modules to check the next to last line (#34819)
* Add validation for the next to last line of a module

* Fix last error code

* Reduce to a single conditional

* Fix conditionals

* Move the final warnings statement to main() in mysql_replication
7 years ago
Matt Martz 86e4619dcf
Update echo ansible-vault example with -n as without this, you get a newline. Fixes #34795 (#34823) 7 years ago
Matt Martz dcc05093db Validate modules arg spec fixes (#34477)
* Update validate-modules arg_spec introspection to be faster, by only mocking the imports we explicitly list
* The use of types.MethodType in redhat_subscription wasn't py3 compatible, use partial instead
* Remove argument_spec import hacks, make them errors, we can ignore them with ansible-test
* Enable the --arg-spec flag for validate-modules
7 years ago
Samer Deeb f8884f12bc Mellanox OS name change: MLNXOS changed to ONYX (#34753)
* Mellanox OS name change: MLNXOS changed to ONYX

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Fix alphabetical order of modules metadata

Signed-off-by: Samer Deeb <samerd@mellanox.com>
7 years ago
Ricardo Carrillo Cruz e9d62e18c7 Mark cliconf refactor on 2.5 roadmap as done (#34735) 7 years ago
Pilou b66863abf0 dev_guide: don't ask to use '© Ansible Project' (#34704)
contributor don't sign any copyright assignment, then this makes no
sense.
7 years ago
Nathaniel Case caf1b357aa
Update ROADMAP_2_5.rst
Mark connection-related tasks as done
7 years ago
Matt Martz d1846425db
Provide a way to explicitly invoke the debugger (#34006)
* Provide a way to explicitly invoke the debugger with in the debug strategy

* Merge the debugger strategy into StrategyBase

* Fix some logic, pin to a single result

* Make redo also continue

* Make sure that if the debug closure doesn't need to process the result, that we still return it

* Fix failing tests for the strategy

* Clean up messages from debugger and exit code to match bin/ansible

* Move the FieldAttribute higher, to apply at different levels

* make debugger a string, expand logic

* Better host state rollbacks

* More explicit debugger prompt

* ENABLE_TASK_DEBUGGER should be boolean, and better docs

* No bare except, add pprint, alias h, vars to task_vars

* _validate_debugger can ignore non-string, that can be caught later

* Address issue if there were no previous tasks/state, and use the correct key

* Update docs for changes to the debugger

* Guard against a stat going negative through use of decrement

* Add a few notes about using the debugger on the free strategy

* Add changelog entry for task debugger

* Add a few versionadded indicators and a note about vars -> task_vars
7 years ago
osLEccse 9c7d987395 Update developing_api.rst (#34629)
Module path needs to be array instead of a string variable in order to work.
7 years ago
Lars Kellogg-Stedman 29fbf0c756 remove erroneous '.' in docsite footer (#34592)
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
7 years ago
Cedric Pimenta cd1b144c0a Improve documentation about Comment filter (#34539)
Include a mention to the decoration option, which allows someone to
specify the character comment to be used.
7 years ago
Adam Miller a67e922a40 fix ansible-galaxy requirements.yml import_tasks->include in docs (#34519)
Signed-off-by: Adam Miller <admiller@redhat.com>
7 years ago
John R Barker 42dd48a6d0
Update done Network 7 years ago
John R Barker 1e292c0211
Correct broken link to playbooks_tests 7 years ago
Yuji Konishi 2039366380 typo (#34549) 7 years ago
John R Barker 1826c27e68
All 2.5 release dates to be pushed out by one week (#34456) 7 years ago
Trishna Guha 9d2182bcf8 Deprecate nxos_switchport and Add nxos_l2_interface DI module (#33813)
* Deprecate nxos_switchport

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l2_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* aggregate test for nxos_l2_interface

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* revert nxos_switchport test change

* gundalow's comment

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
7 years ago
Jordan Borean a830cae160
windows become - info about blank passwords (#34331)
* windows become - info about blank passwords

* Edited for clarity
7 years ago
Abhijeet Kasurde f58d9da703 Update link in common footer (#34397)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Tomáš Karásek ec7b412193 Fix Packet guide to comply with latest version of the packet module (#31410)
* Fix Packet guide to comply with latest version of the packet module

* Fix backticks in rst

* rephrase wait_for_public_IPv description

* Edited for clarity.
7 years ago
Jordan Borean 278663ad2c
windows: updated docs to include info regarding https validation (#34128)
* updated docs to include info regarding https validation

* some doc edits
7 years ago
Jordan Borean 57ed6a866f windows: Add IPv6 address support and docs to go with it (#34072)
* windows: Add IPv6 address support and docs to go with it

* minor docs fix

* fixed some doc sentances
7 years ago
John R Barker 43b0ba0679 Docs network best 2.5 (#33544)
* Best practices for Ansible 2.5 networking

* How to use network_cli
* How to pass credentials

* Proxy

* rename facts-demo.yml + tree

* code-block formatting

* Move platform specific notes to new page (PR pending)

* use ansible_network_os rather than group_names

* Scott's comments

* Update network_best_practices_2.5.rst
7 years ago
Pilou 6a6f5129a9 dev_guide: fix a slip (#34143)
replace 'Formatting options' with 'Formatting functions'
7 years ago
Matt Martz 57575d1cfa
Fix tests as filters #4 (#33930)
* Resolve newly added tests as filters

* Add code smell to test for ansible provided jinja tests as filters syntax

* Add docs for no-tests-as-filters code smell test

* Address tests as filters in new integration tests

* Address feedback

* Address feedback 2
7 years ago
Toshio Kuratomi 94d952f94b
Documentation on how to make a release. (#31426)
* Release Engineering Docs with pointer to the Docs on how to actually make the release.
7 years ago
scottb f8f34c7bab
Moved generated module RSTs to their own directory. (#33966)
* Moved generated module RSTs to their own directory.

* WIP commit - fixed conflict with conf.py exclude_patterns by renaming module RST output directory to 'module_docs'.

* Added new directory to formatter module links; aded new module directory to makefile clean.

* Removed illegal comment from block.
7 years ago
John R Barker c50da48049
Fix various RST warnings (#34084)
* Fix various RST warnings

* shorter lines
7 years ago
John R Barker 7381554e42 Compact documentation (#34081)
Before this fix lists of `documentation:` were in individual <p> tags
causing a lot of whitespace on the rendered _module.html pages.
7 years ago
Jordan Borean 0880297909 fix options output for bool type (#34074) 7 years ago
Trishna Guha be89822bb5
Deprecate nxos_portchannel and add nxos_linkagg DI module (#33376)
* deprecate nxos_portchannel

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_linkagg DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* remove nxos_portchannel unit test

* fix syntax issues

* fix ansible-doc failure

* update nxos_portchannel unittest

* minor fixes and integration test

* update nxos_linkagg
7 years ago
Trishna Guha 3cce8dfafd
Deprecate nxos_ip_interface and Add nxos_l3_interface DI module (#33866)
* Deprecate nxos_ip_interface module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l3_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add integration test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* Add nxapi cli test

* Improve complexity

* manage layer3 interface

* fix unit test
7 years ago
aaron jheng 378636078a use print function (#34013) 7 years ago
Martin Krizek 35c6b17a14 playbook_loops.rst: fix formatting (#34026) 7 years ago
Jordan Borean a2810f44a8 Fixed up windows command quoting example 7 years ago
Will Thames 5f29cd5e60 Add validation test for new copyright (#32919)
* Update validation test for new copyright

Ensure new modules without the new copyright header fail
validation
Ensure existing modules without copyright in top 20 lines fail

* Add documentation of 108 error

Create label in developing modules documentation so that
the validation page can point to it

* Ensure new style copyright header passes test!
7 years ago
Micah Abbott 2f2f118665 python_3_support.rst: fix broken links (#33951)
The links pointing to 'Building From Source' and 'Inventory' were not
valid, so I updated them to point to locations that seemed
appropriate.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
7 years ago
Brian Coca 2b7799f817
added flatten filter (#33102)
* added flatten filter
7 years ago
John R Barker f127e5d535
Fix a few docs build issues (#33685)
Noticed when doing `make webdocs`
7 years ago
Sam Doran bf29cc79a6 Further clarify what determines batch size in a play (#33833) 7 years ago
Jordan Borean 07e9df11b3
windows dev docs - vagrant info (#33515)
* windows dev docs - vagrant info

* added info about FileUtil and LinkUtil

* Initial edit pass - WIP

* updated some wording

* fix some more general sayings to be more professional
7 years ago
John R Barker 33c7a157ab
Create network_working_with_command_output.rst (#33709)
Move this content to new location prior to intro_networking.rst refactor
7 years ago
Pilou 326b208b19 osx_say: add espeak support, rename module to say (#33071)
* Rename osx_say module into say

* say: remove undocumented default value for voice parameter

* say: add support for espeak command

* say: handle check_mode

* say: handle GNUstep tool
7 years ago
Sam Doran b55cc61ef0 Clarify docs to explain that max_fail_percentage uses batch size (#33720) 7 years ago
Matt Martz 2d2f288e77
Add docs describing some additional behaviors around modules (#33631)
* Add docs describing some additional behaviors around modules, to outline why generic modules will not be accepted

* Add/copy the generic module guidelines to developing_modules

* Edits for clarity

* Edits for clarity
7 years ago
John R Barker c2bef76c46
Various doc formatting fixes (#33626)
* Avoid italics from `with_`
* C() is for Modules, not for RST
* RST uses ``...`` for code
7 years ago
Matt Martz 349099a4c6
Fix sorting in man template on python3. Fixes #33663 (#33673) 7 years ago
John R Barker f4cc3fb56d
Remove fixme coment 7 years ago
John R Barker e4a465b6e8
Docs: Network become for privilege mode (#33367)
* Network become for privilege mode

* Document what privilege mode is
* How to tell if you need it
* How to enable
* Tidy up formatting on page
* authorize & auth_pass
* network group_vars.
7 years ago
Renato Piccoli 794c5a6e53 A small typo (RFX->RFC) in vault.rst (#33553)
Correction for a typo in vault.rst.
7 years ago
Matt Clay 90ac38bd4c Fix module validator handling of empty options. 7 years ago
David Chkhikvadze 84ace7acc3 Add missing `be` (#33507) 7 years ago
Ganesh Nalawade 11c9ad23d5
Refactor common network shared and platform utils code into package (#33452)
* Refactor common network shared and platform specific code into package (part-1)

As per proposal #76 refactor common network shared and platform specific
code into sub-package.
https://github.com/ansible/proposals/issues/76

*  ansible.module_utils.network.common - command shared functions
*  ansible.module_utils.network.{{ platform }} - where platform is platform specific shared functions

*  Fix review comments

* Fix review comments
7 years ago
Nathaniel Case 7f90c9d1a7
Warn on `provider` with network_cli (#33355)
* Warn on `provider` with network_cli

also unify action plugins

* Add to porting guide about connection warnings
7 years ago
Zbigniew Jędrzejewski-Szmek 4c29396217 Add dnf and yum commands in "Installation" section (#33369)
* Add dnf and yum commands in "Installation" section

Even though the command is very simple, it's good to be able to c&p it.
There were already commands for apt, emerge, pip, even direct installation
from git, so adding Fedora/RHEL/CentOS examples is reasonable.

Since yum is not installed by default on any supported Fedora releases
(F26 and F28 currently), recommend dnf.

* Tiny edit
7 years ago
Toshio Kuratomi 7bd0af15d2
Enhance empty __init__ code-smell to check module_utils (#33438)
Empty __init__ will allow us to use python namespaces with all of these
files.  That may be something we want to take advantage of for allowign
them to be expanded by user dirs.  Also might be needed for AnsiballZ or
other wrapper enhancements in the future.
7 years ago
Jordan Borean a12e1bfced
stat: added information about get_md5 deprecation to porting guide (#33334)
* stat: added information about get_md5 deprecation to porting guide

* Edit
7 years ago
Eike Frost 16081d2751 Add keycloak_client module for administration of Keycloak clients (#31716)
Allows administration of Keycloak (http://www.keycloak.org/) clients via the Keycloak REST API
7 years ago
Toshio Kuratomi 6e36354740 Update version numbers for the release 7 years ago
Michihito Shigemura 63231457a1 Update links in become.rst (#33383) 7 years ago
Matt Martz 84b8f674a7
Fix py3 docs build (#33345)
* Open file in binary mode to support py3 writes using bytes

* Update sort filter to use an attribute, so that py3 can sort dictionaries
7 years ago
Brian Coca 08f1d1972e correctly document random doc range (#33308)
* correctly document random doc range

fixes #33226

* Edited for clarity.
7 years ago
Matt Martz 4fe08441be Deprecate tests used as filters (#32361)
* Warn on tests used as filters

* Update docs, add aliases for tests that fit more gramatically with test syntax

* Fix rst formatting

* Add successful filter, alias of success

* Remove renamed_deprecation, it was overkill

* Make directory alias for is_dir

* Update tests to use proper jinja test syntax

* Update additional documentation, living outside of YAML files, to reflect proper jinja test syntax

* Add conversion script, porting guide updates, and changelog updates

* Update newly added uses of tests as filters

* No underscore variable

* Convert recent tests as filter changes to win_stat

* Fix some changes related to rebasing a few integration tests

* Make tests_as_filters_warning explicitly accept the name of the test, instead of inferring the name

* Add test for tests_as_filters_warning

* Update tests as filters in newly added/modified tests

* Address recent changes to several integration tests

* Address recent changes in cs_vpc
7 years ago
Samer Deeb cbf28c20cb Add Support for Mellanox switches: first module: mlnxos_command (#33121)
* Add Support for Mellanox switches: first module: mlnxos_command

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Add cliconf support for mlnxos

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* 1- Fix short description, 2- remove waitfor

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* remove usage of check_args

Signed-off-by: Samer Deeb <samerd@mellanox.com>
7 years ago
gaellick bb38e34fc5 add prequisites for ubuntu dev env (#30713) 7 years ago
Pilou 16bcb0393e dev_guide: format code in testing_units_modules.rst (#33009)
* dev_guide: highlight Python code snippets

* dev_guide: use monospace for inline source code

* dev_guide: use links for classes and methods

Methods and classes prefixed with :method: and :class: will become
links once we have documentation for the relevant classes and methods.

Thanks to Toshio for pointing that.
7 years ago
Wolfgang Felbermeier 817a5efff9 Fix css of elbow indentation for firefox (#33225) 7 years ago
Brian Coca 18a4cd3985
draft implicit localhost docs (#31840)
* draft implicit localhost docs

* updated per feedback

* corrected docs to follow desired behaviour

* Edits
7 years ago
Sebastian Safari a05bbb8a1b Update location of facts.py on module dev documentation (#32209)
* Update location of facts.py

I spent some time trying to find out where it was, since it's a 404 on a google search.

* Edits
7 years ago
Brian Coca be00d93eb4 update with implicit localhost (#33146)
* update with implicit localhost

* Minor edit
7 years ago
Sorin Sbarnea 33ce1e1886 Documented use of ANSIBLE_STRATEGY variable (#32973)
Change-Id: I4a14520c14a9d93f06b235eb79720fc674e20cb5
7 years ago
Richlv f8a51355c7 Update playbooks_blocks.rst (#31088)
fix "block:" being referenced as "blocks:"
7 years ago
Siddharth Singh 6674b8e155 Changed Indentation (#31031)
The children 'northeast', 'northwest', 'southwest' weren't properly indented in yaml code.
7 years ago
Wolfgang Felbermeier 496ce388ab documentation: render nested return dicts for more then one level (#33143)
* Render nested return value documentation for more then one level
in the generated webdocs.

* Remove unnecessary code and cleanup

* Implement recursive option documentation

* Build elbow intendation style for options and return documentation
7 years ago
Strahinja Kustudic 673ec2cb78 Add changes to succeeded/failed tests to the 2.4 porting guide (#33201)
* Add changes to succeeded/failed tests to the 2.4 porting guide

* Edit for grammar and clarity
7 years ago
Simon Wydooghe c0fced0d89 Add 'datacenter' keyword arg to secrets.py (#24598)
Fix adds documentation about 'datacenter' in environment variable which is required for gce.py dynamic inventory.
7 years ago
scottb 6ac9d05de6
Removing obsolete version behavior callout notes - initial pass. (#33172)
* Removing obsolete version behavior callout notes - initial pass.

* Fixed example text punctuation.

* Removed old version callout.

* Typo fix

* Updated example

* Fixed awkward sentence

* Fixed incorrect feature name

* Reinstated current version callout
7 years ago
Ganesh Nalawade 0ddf092ae3
Add new filter to parse xml output for network use cases (#31562)
* Add new filter to parse xml output for network use cases

Fixes #31026
*  Add parse_xml filter
*  Add documentation for parse_xml filter

* Edited for clarity.

* Fix review comment and add unit tests

* Fix unit test CI failure

* Fix CI issues

* Fix unit test failures

* Fix review comments

* More copy edits.
7 years ago
André Althaus a9b15ce881 Scan group_vars/host_vars in sorted order 7 years ago
Tom Mast 2995439fbf Fixed simple typo on galaxy page (#33033) 7 years ago
John R Barker 6e4aa49a31 No hardcoding roadmaps (#32981) 7 years ago
Brian Coca afc460c943 tollerate 'string' descriptions 7 years ago
Julien Palard 73d6975611 FIX: Missing space in intro_inventory.rst 7 years ago
Major Hayden 6957339fce [Docs] Fix old YAML style in async docs (#31421)
* [Docs] Fix old YAML style in async docs

This patch fixes some old-style YAML in the documentation for
asynchronous playbooks.

* Removed hard-to-localize colloquialisms
7 years ago
Jiri Tyr f4f5c4d92a Documenting second parameter of the default filter (#31184)
* Documenting second parameter of the default filter

* Edited for clarity and grammar.

* Adding missing colon
7 years ago
Matt Martz 99d4f5bab4 Remove uses of assert in production code (#32079)
* Remove uses of assert in production code

* Fix assertion

* Add code smell test for assertions, currently limited to lib/ansible

* Fix assertion

* Add docs for no-assert

* Remove new assert from enos

* Fix assert in module_utils.connection
7 years ago
Brian Coca a0c0076cfb added note about serial behaviour (#32461)
* added note about serial behaviour
7 years ago
Toshio Kuratomi faa74a8ccd
Add the template lookup escaping to the 2.4 porting guide (#32760)
* Add the template lookup escaping to the 2.4 porting guide
7 years ago
Toshio Kuratomi e07cbb033f Keywords docs (#32807)
* Fixup keyword dumping

* Clarify introductory text
* Turn links in the keyword description into seealso entries in the rst.

* Have plugin_formatter cleanup trailing whitespace

The indent filter in jinja2 < 2.10 indents blank lines by default which
leads to trailing whitespace.  Cleanup after that filter.

* Edits

* Copy edit
7 years ago
Will Thames 316e7939d6 [cloud] Improve aws testing and use `{{ region }}` var (#26892)
* Protect AWS credentials from accidental commits

* Improve documentation for IAM policies

* Update ELB tests to be multi region

Allow AZs to reflect the region in which the tests are run.

This will not work for regions with fewer than three AZs,
but those are relatively rare
7 years ago
Brian Coca 76202bc7c3 removed since 1.2 7 years ago
cnasten f1fe467c22 nso_config module for setting configuration in Cisco NSO (#30973) 7 years ago
Jordan Borean 2f93b7bcb5
win_become: add info about recent admin changes (#32583)
* win_become: add info about recent admin changes

* edits from review
7 years ago
Jordan Borean 15c10981a0
win_dsc: update documentation for latest DSC changes (#32581)
* win_dsc: update documentation for latest DSC changes

* review changes
7 years ago
Trishna Guha 4cc7a89244
Add trishna to committer list (#32663)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
7 years ago
Ganesh Nalawade ff20ac6c52
Add ganeshrn to committer list (#32662) 7 years ago
Kedar K 9b896ca712
add kedarX to commiters list (#32659) 7 years ago
Martin Krizek cd80f26035
Add mkrizek as a commiter (#32644) 7 years ago
Sam Doran d60a1f39d6
Update committers (#32646) 7 years ago
Matt Clay ddae61aab0 Update people section of committer guidelines. 7 years ago
Brian Coca 4fe2c8fece added missing sam 7 years ago
Sloane Hertel 8478b5b6f8
add shertel as a commiter (#32639) 7 years ago
Matt Davis 8a24116dcb
remove experimental warning from become/runas (#32604)
* updated docs/changelog accordingly
7 years ago
Dylan Silva 4bcab82cdb
2.5 roadmap documentation (#32333)
* 2.5 roadmap

* Update ROADMAP_2_5.rst

Minor edits for caps.

* Formatting

* Network Documentation wording & formatting

* Remove smart quotes

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst
7 years ago
James Beake 162ca628d4 fix typo/ URI error (#32531)
URI uses singular: "Listener"

Using current command Listener(s) - plural generates the following error:
PS C:\windows\system32>   winrm enumerate winrm/config/Listeners
WSManFault
    Message
        ProviderFault
            WSManFault
                Message = The WS-Management service cannot process the request. The resource URI does not support the Enumerate operation.

Error number:  -2144108495 0x80338031
The WS-Management service cannot process the request because the WS-Addressing Action URI in the request is not compatible with the resource.
7 years ago
Michihito Shigemura c34c1b6ebd Fix typo/link in plugins/cache 7 years ago
Dmitry Marakasov 843fba509f Documentation typo fixes (#32473) 7 years ago
Jordan Borean d43985aa46
windows development: info about module_utils and requires (#32060)
* windows development: info about module_utils and requires

* Edits.

* update for CI fix

* removed link to Python module utils
7 years ago
Brian Coca 52c97a1cf4 added doc notes about vars plugins in precedence 7 years ago
Victor Martinez 4faf4ff215 Fixed typo (#32450) 7 years ago
Brian Coca 41685fb516 fix precedence issue with facts and vars (#32302)
avoid making gathered facts high precedence, only set_fact is supposed to be.
vars set via set_fact with cacheable are higher precedence than plain facts.

Previously (after 6fbd0a8bb5) regular facts would end up with a
higher precedence than host or play vars, but they should not be. Facts were getting added to 'non_persistent_facts' (equivalent to 'register' vars) which is higher precedence than facts should be.

added 'cacheable set_facts' to precedence docs

'ansible_facts_cacheable' ->  '_ansible_facts_cacheable' (made 'private')
7 years ago
Toshio Kuratomi 42655f737a
Clarify the release and maintenance cycle (#32402)
* Clarify the release and maintenance cycle
* Namespace refs a little
* Fix an unrelated problem with plugin return docs to fix docs build
7 years ago
irsl b456e637e0 become-user example was incorrect
Example was incorrect:
--become-user doesn't imply --become (http://docs.ansible.com/ansible/latest/become.html)
7 years ago
Ed Santiago 47fb002c88 (minor) fix broken link, awkward phrasing (#32085)
* (minor) fix broken link, awkward phrasing

Simple transposition error was resulting in a link not
being properly htmlified.

Also clean up redundant 'this' and trailing whitespace.

Signed-off-by: Ed Santiago <santiago@redhat.com>

* Edits
7 years ago
Greg DeKoenigsberg 80031720d1 Deprecate old community guide (#32266)
For anywhere we still have links, we want to deprecate this page and point them to the right new page.
7 years ago
Greg DeKoenigsberg c5b4d53c09 Update index.rst to point to new community guide (#32263)
We made this change a couple of months ago, deprecating community.html in favor of community/index.html and its full guide, but the change was never made here in the index.
7 years ago
Aaron Huslage 01af68911f Change 'connection' to 'inventory' in description
Fixing a copy/paste typo.
7 years ago
Toshio Kuratomi cf2c22770a Update release and maint for new release 7 years ago
John R Barker 1d86205933 Correct formatting --arguments (#31808)
* Correct formatting

* Use RST :option:

* ansible-pull --vault-password-file

* Streamlined the language a bit in the intro.

* Exclamation point removal!
7 years ago
Matt Clay 36b13e3e3d Fix ansible-test default image. (#31966)
* Add openssh-client to default docker container.
* Include Azure requirements in default container.

To do so, handling of pip requirements was updated to install each
set of requirements separately and then run a verification pass to
make sure there are no conflicts between requirements.

* Add missing --docker-no-pull option.
* Add documentation for the azure-requirements test.
7 years ago
mikedlr fbbffbabde Mdd module unit test docs (#31373)
* new documentation for unit testing - especially module unit testing

* unit test documentation reformatting and further fixes

* unit test documentation - point to online coverage reports & fix bad spaces

* Small copy edits.

* First pass copy edit / rewrite. More info needed.

* testing documentation - clean up structure, especially code coverage - reduce repetition

* module unit test documentation - improved introduction

* testing documentation - more fixes from and inspired by review from dharmabumstead

* testing documentation - fixes from mattclay + some other minor tweaks

* More copy edits.

* testing documentation - further fixes from review

* Copy edits

* Copy edits

* More copy edits.
7 years ago
Dan Bohea be3f911ce3 Typo on "Prompts" page (#31882) 7 years ago
Dag Wieers 3182a878b5 Fix small typo 7 years ago
Jordan Borean 836677522d fixed up code-block for powershell block 7 years ago
Abhijit Menon-Sen a84545dc33 Fix typo 7 years ago
Gregory M. Dulin 29a5938fb1 Update --extra-vars documentation. Fixes #11647 (#31433)
* Update --extra-vars documentation to address #11647

* Fix some grammar

* Fix indentation

* Reshuffle and add versionadded tags

* Remove code-block tags

* Add lf after versionadded lines
7 years ago
wxdao 8a86746223 Fix typo in playbooks_error_handling (#31636) 7 years ago
Jordan Borean f2fed10ad8 update Windows docs (#30783)
* first round of splitting and expanding Windows docs

* Added info about WinRM and started the usage page

* more details onf usage around command/shell

* added more info

* missed a page

* added info about hotfix and ps upgrade script

* Added DSC information

* filled in FAQ and fixed up links

* changes per PR review and typo fixes found by myself

* fixed sanity check

* updated external script URLS

* Edits

* Edits

* Edits

* Copy edits.

* More copy edits.

* Added info about becoming a local service account

* some formatting changes on become and DSC indent fix

* Copy edits/rewrites

* Copy edits/rewrites

* minor updates to UAC text, typos

* minor wording updates

* minor wording tweaks/typos

* minor wording tweaks/typos

* minor tweaks/typos

* fix indent issue

* fix title underline length

* fix quote issue
7 years ago
Peter Weldon 94a558887a Fix typo in command output of encrypt_string example. (#31601) 7 years ago
Tim Rupp 20e546258d Adds new committer to Ansible core (#31544)
This is me (Tim) signing and agreeing to the committer guidelines.
7 years ago
Brian Candler 6f9e2b9a63 Add ellipsis to indicate YAML example is excerpt, not standalone 7 years ago
Brian Coca 2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
7 years ago
Brian Coca d84df2405d move from with_<lookup>: to loop:
- old functionality is still available direct lookup use, the following are equivalent

  with_nested: [[1,2,3], ['a','b','c']]

  loop: "{{lookup('nested', [1,2,3], ['a','b','c'])}}"

- avoid squashing with 'loop:'
- fixed test to use new intenal attributes
- removed most of 'lookup docs' as these now reside in the plugins
7 years ago
Toshio Kuratomi c81314dcb9 Add a hack to test whether type=path should be used in a module 7 years ago
Brian Coca dc69af50dc clarified inventory_dir changes for 2.4 (#31484)
* clarified inventory_dir changes for 2.4

added example on how to restore (mostly) old behaviour for add_hosts

fixes #30901
7 years ago
Brian Coca 7d49b27218 added toggle to control vars plugin behviour
this should allow user to control how they want the playbook dirs inspected
for additional vars, default now reverts to 2.3 behaviour (top).
corrected paths order
minor doc reword
7 years ago
Richlv 1037c211d9 Update playbooks_lookups.rst
fix doublequote being used in place of the colon
7 years ago
Lindsay Hill 146f90e16b Fixed RST hyperlink issues (#31394) 7 years ago
sduthil 15dffe04dd fix misformatted docsite link (#31384)
reason: The link is showing verbatim in the docs, where it should only
show "knowledge base article".

Also, generating the docs shows a lot of:

docs/docsite/rst/win_acl_module.rst:424: WARNING: Unknown target name: "know ledge base article<https://access.redhat.com/articles/rhel-top-support-policies>".
7 years ago
John R Barker b79d15e67f Improve and link Network Proxy docs (#31316)
* Improve and link Network Proxy docs

It is possible for proxy issues to cause "unable to open shell", so
detail there.

Having the "how-to" in the debug page makes more sense than on the
porting page, so move it.

Fixed a few formatting issues at the same time.

* Edits

* typo
7 years ago
Brian Coca 5085c3b859 made note about cwd not working for hostlist anymore (#31258)
* made note about cwd not working for hostlist anymore

fixes #31041

* Edits
7 years ago
Jorgen c41f781e1d Make YUM repo URL clickable again (#31264)
Make YUM repo URL clickable again
7 years ago
Andreas Olsson ba0b91b51b Remove git:// urls from docsite and from packaging (#30459)
It's almost always preferable to clone by way of https:// rather than
using the bare git:// protocol. Not only does https:// provide
stronger guarantees it also plays nicer with corporate proxies, etc.
7 years ago
Michihito Shigemura a71ca66e6e Fix typo in dev_guide/testing 7 years ago
Michihito Shigemura 78fd326908 Fix typo in dev_guide/developing_program_flow_modules 7 years ago
Dylan Silva 614a2b403e fixed url issue for rpm location (#31164)
Thanks @thaumos!
7 years ago
Michihito Shigemura d0d1c7d249 Fix typo in dev_guide/developing_plugins (#31142) 7 years ago
Michihito Shigemura 221c01ff49 Fix typo in dev_guide/developing_modules_general (#31122) 7 years ago
Michihito Shigemura b7b8c669a3 Fix typo in dev_guide/developing_modules_documenting (#31120) 7 years ago
Daniel Linder 90dd698b86 Example of idempotent (pseudo-)random() usage. (#31048)
Add note to use idempotent random() seed based on inventory_hostname.
7 years ago
Luke Short c6a676c025 correct the Python 3 Pip environment setup instructions (#30988) 7 years ago
tom-clx 04bfbb14d6 Update playbooks_blocks.rst (#24069)
* Update playbooks_blocks.rst

The rescue section documentation should be clear that successful completion of a rescue section will override other error handling behavior.

* more precise rescue docs

explains in detail the consequences of successful rescue
7 years ago
Dag Wieers e63d949951 Add a blank line, and use the Copyright format as used during rewrite
So there is a discrepancy between the dev guide and what has been changed on disk by toshio.
Not a big deal, but needlessly confusing.
7 years ago
Brian Coca cd5cadfe69 added note about inventory_dir new behaviour (#30865)
* added note about inventory_dir new behaviour
7 years ago
Michihito Shigemura b3cee37dc1 Update links in style_guide/trademarks (#30809) 7 years ago
Brian Coca 17f094bb6a corrected import_play into to import_playbook (#30853)
* corrected import_play into to import_playbook

fixes #30744
7 years ago
Matt Martz d40eff720c Update API example for 2.4 7 years ago
scottb 6c732bb670 Plugin doc update edits for #30490 (#30889)
* Edit pass 1 for #30490 - command line tools and developing plugins.

* Continuing edit pass for #30490. WIP

* Last round of copy edits for #30490.
7 years ago
cclauss 25e17b4035 Clearify that Python 3 support is still a tech preview (#30789)
setup.py does not contain any Python 3 trove classifiers.
7 years ago
Michihito Shigemura b3177383da Fix typo in docs spelling_word_choice (#30785)
shocked that someone else spells the correst way, like me
7 years ago
Brian Coca 8d56064ce4 fixed typo in if, restore module docs 7 years ago
Michihito Shigemura 303d622dcb Refactor doc resources in style_guide (#30794)
- Change links from http to https
- Correct or remove dead links
7 years ago
Brian Coca b233f3f296 updated plugin docs (#30490)
* updated  docs

- for devs:
  - added inventory/vars section
  - made some updates to general section and other plugin types
- for users:
 - added 'user' plugin section to start describing the plugins
 - docs on types, what they are and how to use

- removed ref to deleted AUTHORS file
- corrected several typos/headers
- added descriptions to config.rst template
- ignore generated files for cli/plugins and config
- remove new generated files on `make clean`
- moved details from devguid and intro doc to plugin specific pages
- pretied up lookup notes
- changed precedence ref to not conflict config
- removed duplicate config data, as config is autogenerated and up to date
- put new plugins under playbooks
- added `pass` cause rst/python dislikes fractions
- removed dupe in .gitignore, alpha sorted to avoid moar dupes
- added try cause rst/python freaks out

* generate plugins into their own dir

only do plugins that support docs
use toctree from main plugins page
7 years ago
Matt Bruzek aaaf88908d Adding a section to the FAQ about array notation. (#30782)
* Adding a section to the FAQ about array notation.

* Fixing spelling of jinja and Celsius.

* Adding an example that uses dots.
7 years ago
Michihito Shigemura b5546328dc Fix typo in docs grammar_punctuation (#30718) 7 years ago
David Moreau Simard f8230d961d Link to all the porting guides instead of just the 2.0 one (#30671) 7 years ago
jborean93 0e22afef52 fix for make webdocs 7 years ago
Dag Wieers 31e7d735a3 win_environment: Make this the Windows reference module
As discussed before we selected win_environment to the documentation,
and point to win_uri for a more advanced module.

If we want to make this the reference module, we have to get this one
absolutely right in every possible way.

This PR cleans up both win_environment and win_uri, and makes the
required changes to the windows module development section.
7 years ago
Brian Coca 5220f30244 decelerate docs! 7 years ago
Dylan Silva 2f67dd1e0f Updated release table for docs (#30649)
- Updated table to reflect release of 2.4
- Added in 2.5 as current devel
7 years ago
Brian Coca a030472092 More porting updates (#30635)
* Update porting_guide_2.4.rst with more docs and some rst fixes
7 years ago
Monty Taylor 700a032bf1 Add an example of complex return argument (#28610) 7 years ago
Brian Coca 22c8522cbf added missing feature info (#30560)
* added missing feature info

mostly config related

* Copy edit

* Copy edit

* Copy edit. Clarified warning.
7 years ago
Austin S. Hemmelgarn d5ae9d1018 Fix build on Python 3.x by using sys.maxsize. (#30424)
As outlined in https://docs.python.org/3.1/whatsnew/3.0.html#integers,
sys.maxint doesn't exist anymore in Python 3.x because there is no maximum
value for integers in Python 3.x.  sys.maxsize is present in all
versions of Python that are currently supported by Ansible, so use that
instead as an arbitrarily large index value.

Fixes the following build error when building with Python 3.x:
make -j1 docs
mkdir -p ./docs/man/man1/ ; \
PYTHONPATH=./lib docs/bin/generate_man.py --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
Traceback (most recent call last):
  File "docs/bin/generate_man.py", line 253, in <module>
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "docs/bin/generate_man.py", line 119, in opts_docs
    'long_desc': trim_docstring(cli.__doc__),
  File "docs/bin/generate_man.py", line 34, in trim_docstring
    indent = sys.maxint
AttributeError: module 'sys' has no attribute 'maxint'
make: *** [Makefile:347: generate_asciidoc] Error 1
7 years ago
Adrian Likins da15cf1f54 Generate plugin rst (#28901)
Generate rst docs for plugins 

Based on rst generated for modules. But generated plugin
docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst
( docs/docsite/rst/plugins/connection/ssh.py for ex)

* move plugins docs to rst/*_plugins/ subdirs for namespace
* Only gen support pages for modules for now.
* Add generated plugin docs to gitignore* add list_*_plugins templates
* support MODULES/PLUGINS filters for make htmldocs

   Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for.

* fixup 'historical' version_added, skip plugins/loader.py
* Fix plugins_by_support ref link to new plugins/*/ location
* use :ref: for common_return_values, allow empty version_added
* warnings on missing doc info
* add a prefix to _random_choice
  It was colliding with the target for random_choice plugin
7 years ago
Toshio Kuratomi c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
Brian Coca 1062f52f4c cleanup generated CLI rst 7 years ago
John R Barker 5a256dd1c0 porting_guide_2.4 stub entries (#30456)
Addtions to porting_guide_2.4

* deprecated notice for win_package return values
* Added vars plugins, config api, inventory plugins.  These were mostly backwards compatible.
  Added notes for users and devs to check out new features once i write the 'feature docs' I'll
  come back and link to them from here
7 years ago
Adrian Sadłocha 22f3898412 Fix a typo in docs 7 years ago
James Cammarata 366a9d861f Cleaning up use of include: in docs (#30466)
* Cleaning up use of include: in docs

Switching to import_*/include_* instead.

* Update playbooks_best_practices.rst

* Fix rst syntax
7 years ago
John R Barker 785e604c57 Porting Guides 2.4 (#24539)
* Porting Guides for Ansible Versions

Improve the user facing documentation.
Tell people what changes they need to make

* More porting guides

* Link porting guides from TOC

* Link porting guides from CHANGELOG.md

* typo in link

* Review feedback

* Better CHANGELOG links

* Better links

* code blocks

* Minor changes

* Correct links, comment out network section in 2.4

* Typos

* Revert non 2.4 changes

* Add placeholders for other items

* multiple inventory

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* add win_command/win_shell escaping notes

* Added some windows porting info

* Edit for grammar

* Correct links, delete Net Platform Agnostic

* 2.5 link

* Network changes in 2.4

* facts_namespacing was pushed back to 2.5

Due to lack of time we pushed this back to 2.5 so that the facts in the namespace could be shortened.

* Python version

* Remove FIXMEs - move to seperate PR
7 years ago
Ganesh Nalawade 11310b8c4a Update removed_in_version to 2.9 for network module top level cred args (#30416)
* Update removed_in_version to 2.9 for network module top level credential args

* Add documentation
7 years ago
Toshio Kuratomi 8a2f069468 Document boolean default value treatment (#30062)
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity
7 years ago
Adrian Likins dfc0084f01 rename dev..general_OLD.rst to ._rst (#30291)
So we don't try to build the rst, since it causes
lots of warnings to be shown and doesn't render correctly.
7 years ago
Adrian Likins 9cc63326b1 Misc docsite fixes (#30290)
* Fix refs for local_facts and various cli :option:
* Fix dev_guide/testing_pep8 refs
* remove ref to non-existing 'developing_test_pr'
* Fix ref to ansible-vault encrypt_string
* Removed hard-to-localize colloquialism.
* Rename '_ansible-pull' in playbooks_intro.

It was conflicting with rst/ansible-pull.rst. Nothing
seems to reference it.

* Add explicit targets for and update refs

Replace some ':doc:' use with ':ref:'.

Replace some :ref: to section names with explicit targets
(:doc:`Dynamic vs. Static` -> :ref:`dynamic_vs_static` etc)

* The 'YAML+Jinja' syntax lex fails here, so just use yaml

Since the yaml+jinja highlight fails, code wasnt highlighted
at all, but 'yaml' works more or less.

* just use no lexer for the < python2.6 examples

py3 will fail highlighting them, and 'python2' throws
a lexer warning, and nothing actually highlights it, so
just disable.
7 years ago
Aren 60d9a12efd swapped out key-value pairs for multi-line YML (#30277) 7 years ago
John Patrick fc5b74fad2 fix broken rpm link (#29667) 7 years ago
John R Barker ac6205b9e8 porting_guide_2.5.rst stub (#30311) 7 years ago
Adrian Likins 633263d535 add htmlsingle target (#30287)
For whatever reason, building the 'singlehtml' version of
the docs is much much faster than building the normal html
version.
7 years ago
Matt Clay df941df01d Remove references to obsolete PR Mover. (#30298) 7 years ago
Ganesh Nalawade 530988666a Allow delegate_to if transport is not cli (#29945)
Fixes #29060

Allow delegate_to if transport is either nxapi or eapi.

Persistent connection uses `cli` transport and create
a local socket on control node. Hence delegate_to is not allowed
for `cli` transport.

However as `nxapi` and `eapi` transport does not use persistent connection
it is possible to use delegate_to in this case.
7 years ago
Dylan Silva 88aa0b7645 Fix bugs with modules_support.rst 7 years ago
Toshio Kuratomi ff13d58c14 Remove use of unicode_literals as it is an anti-pattern
from __future__ unicode_literals leads to developer confusion as
developers no longer can tell whether a bare literal string is a byte
string or a unicode string.  Explicit marking as u"" or b"" is the way
to solve the same problem in the Ansbile codebase.
7 years ago
Abhijeet Kasurde 8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Cheng Lian 4c229e566e Fix minor formatting issue in python_3_support.rst (#29161)
Thanks @liancheng!
7 years ago
Luke Short 897f86561f document the required variables for using Windows certificates (#29112)
* document the required variables for using certificates when authenticating to Windows

* clarify that certificates are for local (non-domain) users
7 years ago
Will Thames c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
7 years ago
jhawkesworth 3d5320adad fix typo in new jsonquery filter example that uses backticks (#29082) 7 years ago
Adrian Likins 52f2edf19d change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.
7 years ago
Adrian Likins 89c973445c generate rst doc pages for command line tools (#27530)
* let generate_man also gen rst pages for cli tools
* make template-file, output-dir, output format cli options for generate_man
* update main Makefile to use generate_man.py for docs (man pages and rst)
* update vault docs that use :option:
* Edits based on
6e34ea6242 and
a3afc78535

* add a optparse 'desc' to lib/ansible/cli/config.py 

  The man page needs a short desc for the 'NAME' field
  which it gets from the option parse 'desc' value.

  Fixes building ansible-config man page.

* add trim_docstring from pep257 to generate_man

  use pep258 docstring trim function to fix up any indention
  weirdness inherit to doc strings (ie, lines other than
  first line being indented.

* Add refs to cli command actions

To reference ansible-vaults --vault-id option, use:

:option:`The link text here <ansible-vault --vault-id>`

or:

:option:`--vault-id <ansible-vault --vault-id>`

To reference ansible-vault's 'encrypt' action, use:

:ref:`The link text here <ansible_vault_encrypt>`

or most of the time:

:ref:`ansible-vault encrypt <ansible_vault_encrypt>`
7 years ago
Brian Coca f4fff54f68 clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.
7 years ago
Will Thames 0d69b63c01 Additional simpler json_query documentation (#24041)
Since json_query treats backticks as delimiters for literals,
some of the examples in the json_query docs can be made a little
simpler. Rather than replacing such examples, demonstrate the
alternative
7 years ago
Brian Coca c3550b58ed introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits
7 years ago
Brian Coca 48da0597c0 document ansible_group_priority (#28777)
* document ansible_group_priority

* Copy edit pass
7 years ago
Matt Clay fe90866819 Fix rst syntax issue in docs. 7 years ago
Dylan Silva ecc1fbcc1d updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
7 years ago
Sam Doran 02a362e7de Replace rst extension with html in message (#29022) 7 years ago
Eddie Peters ea74176a28 Fix small typos and extra whitespace in the docs (#24559) 7 years ago
Sam Doran f0a0b630f6 Properly format inline code. 7 years ago
Ian Wienand 35d02b28c9 Minor syntax error in block versionadded
The syntax for versionadded is to have the string as a second
argument.
7 years ago
Nicklas Laine Overgaard 859b5df1d4 Fix exported SSL_CERT_FILE variable (#28968)
The variable was pointing to a file with a `.cer` extension but the curl command downloads a `.pem` file which makes executions of the bash script fail
7 years ago
Pilou d67d202227 Fix typo: s/certfied/certified/ (#28951) 7 years ago
Toshio Kuratomi 13b2bedae6 Make python3 testing doc clearer for distro packaging users (#28948)
https://bugzilla.redhat.com/show_bug.cgi?id=1486612
7 years ago
Fran Fitzpatrick c51f2f835e Adds documentation for all the regex filters (#28944) 7 years ago
Matt Davis 59787a3dbc minor fixes to docsite root URLs (#28945)
* fix hardcoded http schemes to use relative URLs
* add doc fragment to version selector link to scroll target directly to the selector
7 years ago
Scott Butler a9f82f8a8a Fixed incorrect version numbers. 7 years ago
Scott Butler c479d37777 Changed header to say 'devel' instead of 2.4 7 years ago
Lars Kellogg-Stedman 7093622571 docs: add fact caching directives to intro_configuration (#27040)
the fact_caching* configuration directives were not listed in
intro_configuration.rst.
7 years ago
Ron V 8999b98a09 Update playbooks_best_practices.rst (#26714)
fix point of confusion for newer users
7 years ago
Sam Doran cc7e38890c Clarify how tag inheritance works (#28942)
Fixes #20119

Another crack at PR #27147
7 years ago
Adrian Likins 596dc8c442 Add ANSIBLE_CONFIG envvar to config/envvars tmpl (#28886) 7 years ago
Adrian Likins 933298505a Update places we mention env vars to use :envvar: (#28887) 7 years ago
Peter Sprygada ae2e84146e update network section for completed items (#28927) 7 years ago
Adrian Likins 28b9dc4bed Vault docs (#26979)
* start rst docs for ansible-vault encrypt_string

* wip, vault format docs

(sorta markdown ish atm)

* wip - formatting

* wip, vault docs

* Fix refs to other docs for now

fixing default_role in conf.py will remove need
for this

* add 'ref' to cli names

* more vault docs

* wip, misc fixes

* add some encrypt_string examples

* Fix up rstcheck warnings

The code blocks in question included the output that would
be echo'ed from running the command, which isnt valid bash.

* fix formatting and rstcheck warnings about code-block

* Add envvar ref for ANSIBLE_VAULT_PASSWORD_FILE

* fix doc title

* Fixed title underline
7 years ago
scottb b146e17733 Edit pass for relocated community documentation. (#28368)
* Edit pass for relocated community documentation.

* Updated info on Ansibullbot

Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags

* Update communication.rst

Add Contents
Use correct headings

* Update communication.rst

* Topics, remove whitespace, codeofconduct

* Formatting

* Correct heading

* Update maintainers.rst

* Minor edits and a request for more info

* Removed some hard-to-localize wording.

* Removed incomplete sentence

* Minor edits per review
7 years ago
Scott Butler c7c30c6760 Fixed wording. 7 years ago
Giovanni Sciortino d733f5af06 Add note in documentation and add warning related to retries parameter used without until (#28078) 7 years ago
Adrian Likins 8035e68d44 Generate a rst for config and env options from base.yml (#28739)
* wip, gen docs from config/base.yml

* wip

* dont change conf.py here

* cleanup, add dump_config --template-file cli opt

* some desc are string, some are lists...

TODO: fix base.yml so it is consistent

* Filter out TODO and empty descriptions
7 years ago
Sam Doran 80c00d3238 Create urlsplit filter (#28537)
* Improve tests for uri filter

* Create URL Split docs

* Add urlsplit filter

* Py3 compatibility

* Use helper method and eliminate query options

* Add options, cleanup output, fix tests

* Update docs

* Add parenthesis to boilerplate import

* Add debug task to tests

* Use exclude option to filter returned values

* Filter out additional option for Python 3
7 years ago
Matt Davis b3f2d1befe expose cloud_environment override in azure_rm modules (#28743)
* Can be set via env, credential profile, or module arg
* Valid values defined by Azure Python SDK, currently `AzureCloud`,`AzureChinaCloud`,`AzureUSGovernment`,`AzureGermanCloud` or any Azure Stack metadata discovery URL.
7 years ago
Chris Houseknecht d513c430de Updates community code of conduct email 7 years ago
Jason McKerr 9a2065fcf3 Update ROADMAP_2_4.rst 7 years ago
René Moser c97f4653be fix typos in various modules and docsite (#28747) 7 years ago
Jordan Borean 9b48c377b4 updated windows roadmap (#28740) 7 years ago
Reid Wahl ca91b361ce Fixes #28290: Added missing colon for paramiko host_key_auto_add line in network_debug_troubleshooting.rst (#28695) 7 years ago
Reid Wahl 3ca415f58c Fixes #21041: Add note to intro_inventory.rst that the Docker example is a playbook and not an inventory file (#28697) 7 years ago
Dag Wieers ccb6b39f45 Corrected RETURNS -> RETURN 7 years ago
Brian Coca 203d8d2e6e added diff keyword to changelog/docs 7 years ago
René Moser 6397e68bfd doc: replace play_hosts with ansible_play_batch (#28526) 7 years ago
Matt Clay 871bd24358 Fix documentation references. 7 years ago
Shane McDonald f108057f61 Bump version in docs layout (#28523) 7 years ago
Toshio Kuratomi 40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
7 years ago
Toshio Kuratomi 84ea2af4b6 Remove nonexistent special_interest-groups doc 7 years ago
Toshio Kuratomi 212499a489 On clean, remove the *_maintained.rst generated files 7 years ago
Jiri Tyr 5660b18b6a Adding missing period into the module doc template 7 years ago
David Kretch beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440)
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
7 years ago
David Moreau Simard 022ce7efee Docs for multiple asynchronous tasks (#24457)
* Add docs on the behavior of with_items flattening and nested lists

* Add docs on limiting the amount of concurrent async tasks
7 years ago
Andreas Maier b900f4a3be Fixed return table in module docs generated by plugin_formatter.py (#25329) (#25330)
This change fixes two issues with the generated return table:

1. When specifying a list of strings in the 'description' field of a
   return value, it shows them in Python list syntax on the resulting
   web page, e.g. `['a', 'b', 'c']`.
2. When specifying more than one line for the 'sample' field, the
   result table gets damaged in the HTML output.

In addition, this change re-arranges the HTML tags produced in the
generated RST file such that they line up nicely and can better be
checked by humans for completeness.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
7 years ago
Adrian Likins 2941e86671 Fix plugin_formatter.py -l / MODULES=none make webdocs
Fix the get_module_info check against the limit_to_modules
list so building a subset/none of the module docs works again.
7 years ago
David Moreau-Simard e9d6d37589 Update release status for 2.3 to 2.3.2 7 years ago
Peter Sprygada 2e44d8913b update parse_cli documentation with more examples (#28258)
* update parse_cli documentation with more examples
7 years ago
Tom Paine 50d744c217 Update playbooks_filters.rst (#28271)
See #17266, password_hash has been updated to support passlib. The available hashes are listed on http://docs.ansible.com/ansible/latest/playbooks_prompts.html, but not here.
7 years ago
Sam Doran b7aa38c0d8 Minor fixes to Developer Docs (#28302)
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
7 years ago
Matt Clay b52aeeabfa Roadmap updates and docs fix. (#28287)
* Update on 2.4 roadmap progress.
* Fix docs syntax for Python 2.
7 years ago
Toshio Kuratomi 546187a8af Revamp the plugin_formatter doc generator
* Use a template to generate the category lists
* Refactor so that we first extract all of the data that we need to
  build the docs and then give that data to the templates to build with
* Add docs page listing modules ordered by support level
7 years ago
Toshio Kuratomi af2073d057 metadata 1.1
* Add network value to support_by field.
* New support_by value, certified
* Deprecate curated in favor of certified
* Add conversion from 1.0 to 1.1 to metadata-tool
* Add supported by Red Hat field to ansible-doc output
7 years ago
CyberArk BizDev d50d65d448 Added cyberarkpassword lookup plugin (#21857)
* Added cyberarkpassword lookup plugin

Added cyberarkpassword lookup plugin: It allows to retrieve credentials
(password, sshkey) from CyberArk Digital Vault
7 years ago
Jason McKerr cc36153928 Update ROADMAP_2_4.rst 7 years ago
hsmtkk 3f9d6aa0f1 doc: fix a typo (#28215) 7 years ago
Aleks Daranutsa f668f41822 Spelling and Grammar for playbooks_reuse.rst (#28174)
* Spelling and Grammar for playbooks_reuse.rst

* Minor edits.
7 years ago
scottb b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
7 years ago
Toshio Kuratomi fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
7 years ago
René Moser eec4434b9b doc: cloudstack: fix formating issue in guide (#28162) 7 years ago
Greg DeKoenigsberg d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
7 years ago
Greg DeKoenigsberg 75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
7 years ago
Greg DeKoenigsberg b3ed699132 Copying code of conduct from community.rst (#28136) 7 years ago
Greg DeKoenigsberg 608c69279c Moving "communication" info from main community page (#28135) 7 years ago
Duncan Lock 9a2ae022f5 Format the versionadded block correctly (#28085)
Currently broken on the live docs site: http://docs.ansible.com/ansible/latest/playbooks_blocks.html
7 years ago
Prasad Katti 2c85ca3729 Formatting changes (#28133) 7 years ago
Greg DeKoenigsberg 5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 7 years ago
Adrian Likins a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 7 years ago
Greg DeKoenigsberg 3ec7e030bf Completed draft of How Can I Help 7 years ago
Greg DeKoenigsberg f8f17c0c27 Add basic info on pull requests 7 years ago
Greg DeKoenigsberg 418dd0cd4a Iterating on How Can I Help
A little more content
7 years ago
Greg DeKoenigsberg ba065637ff Add roadmap to development process doc 7 years ago
Greg DeKoenigsberg 792bfa657c formatting tweak 7 years ago
Greg DeKoenigsberg e43d1da938 formatting tweak 7 years ago
Greg DeKoenigsberg d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
7 years ago
Greg DeKoenigsberg ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
7 years ago
Stefan Midjich 6e4c0143b4 Typo in module example code (#28064)
In the DOCUMENTATION constant there is a typo on line 85 of this rst file.
7 years ago
Thomas Stringer e4cd899363 Add support for Azure 2.0.0 (#27920)
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support

* Fix exceptions in Azure ARM plugins

* update azure_rm_networkinterface documention to reflect required params

* change state param to not required for docs in azure_rm_subnet

* fix import to reflect azure==2.0.0 changes

* add aliases and fix docs for azure_rm_storageblob

* add resource_group_name alias to azure_rm_storageaccount_facts

* fix import bug due to change in azure==2.0.0

* fix args bug and enum modules issue

* update docs to reflect azure==2.0.0

* pin management clients to a specific api_version

* update docs to reflect the new azure-ansible-base python package

* add fallback for older api resource group listing

* rework azure dependencies installation

* refactor path joining to a cross-plat solution
7 years ago
Jordan Borean 7c59b66802 updated changelog for windows (#28040) 7 years ago
Brian Coca 914ae2fb26 added docs for undocumented play object entries 7 years ago
David Newswanger ebb1d75ee0 fixed a syntax problem that was preventing a warning box from being displayed 7 years ago
Prasad Katti 2a63693580 Minor fix in docs 7 years ago
Brian Coca 940a74a93a fixed include_role doc example (#27986)
fixes #27985
7 years ago
Dag Wieers 49aa64a5b8 Various small changes and adding myself
Unfortunately, the Github interface does no longer allow me to edit a file in the GUI and then branch it in my personal clone for making a PR. It now only offers to make a PR using a branch on the ansible repository :-(

So committing this directly instead against my will, but per the guidelines this appears to be safe. Fingers crossed...
7 years ago
Jordan Borean 362f032449 Changed docs requires to new format (#27918) 7 years ago
Joseph Miguel f88f4394c8 Update developing_api.rst (#25922)
* Update developing_api.rst

* Update developing_api.rst

Edited.
7 years ago
Arthur Kepler d828449611 Corrects default arg format used by datetime filter (#27612)
This ensures the default datetime format matches that of
datetime.datetime. Docs updated to match as well.
7 years ago
Toshio Kuratomi 44935a5db6 Add a (disabled) code-smell test for detecting _ variables
We are reserving the _ identifier for i18n work.  Code should use the
identifier dummy for dummy variables instead.

This test is currently skipped as someone needs to generate the list of
files which are currently out of compliance before this can be turned
on.
7 years ago
Peter Sprygada 2d5908255a add parse_cli and parse_cli_textfsm to documentation (#27755)
* add parse_cli and parse_cli_textfsm to documentation

* Minor edits.
7 years ago
Scott Butler c43a10bd69 Another clarifying note on Python supported versions. 7 years ago
Scott Butler 7d553aad29 Added note clarifying which version of Python 3 we support. 7 years ago
Scott Butler 699e0ccc32 Added note clarifying Python 3 supported versions. 7 years ago
Branko Majic f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
7 years ago
Scott Butler bfe470d391 Minor edit 7 years ago
Scott Butler 6d59ac1bb4 Updated per tech review feedback. 7 years ago
Scott Butler b2ec984130 Updating packaging locations - incorporating review feedback. 7 years ago
Toshio Kuratomi f4d7b9a596 code-smell test changes
* Create get_exception and wildcard import code-smell tests
* Add more detail to boilerplate and no-basestring descriptions
* Remove the no-list-cmp test as the pylint undefined-variable test covers it
7 years ago
Yaacov Zamir 48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
7 years ago
John R Barker 7f8aaf97de rst validation fix (#27698) 7 years ago
Greg DeKoenigsberg aca4504e96 Simple "good enought" index page (#27667)
Removing the FIXME, just a peppy little starter page.
7 years ago
John R Barker df58d943d3 Docs porting guides 2.0 & 2.3 (#27632)
* Create new "Porting Guide" section

Create new landing page
Add porting_guide_2.3

* correct CHANGELOG

* Document blocks

* Document named blocks

* OpenBSD & async action plugins

* OpenBSD & async action plugins

* versioadded for name

* review comments
7 years ago
scottb 3476b005b9 Initial pass at consolidating community content [work in progress] (#27661)
* Added placeholder topics for community info

* Setup community section index.

* Initial move of triage process docs.

* Typo/test

* Removed triage topic from index.
7 years ago
Adrian Likins ac37be9761 update roadmap (multiple vault secrets merged) (#27644) 7 years ago
Abhijit Menon-Sen 20b0716948 Allow variables to be passed in to template lookup plugin (#18662)
This allows a single template to be evaluated with different values in
the same task. For example, with a template like 'x:{{a}}', one could do
something like this:

    - foo:
        a: "{{ lookup('template', 'x.j2', template_vars=dict(a=foo[item])) }}"
        b: "{{ lookup('template', 'x.j2', template_vars=dict(a=bar[item])) }}"
      with_items:
        - x
        - y

…and "a" and "b" would expand to different strings based on what we
passed in to the template lookup.
7 years ago
Ganesh Nalawade 70ce394840 Persistent connection timer changes (#27272)
*  Add command_timeout timer that defines the amount
   of time to wait for a command or RPC call before
   timing out.
*  Remove connect_retries and connect_interval configuration
   varaible and replace it with connect_retry_timeout to control
   the timeout value of connection to local scoket.
*  Make required changes to netowrk action plugins and relevant
   network files in module_utils.
*  Required documentation changes.
7 years ago
Brian Coca 842951f00d added note about not all tasks being 'delegatable' 7 years ago
Scott Butler 12e349fe48 Updated package locations. 7 years ago
Matt Davis e4d153bd5d update WSL installation docs for current builds (#25237)
* supersedes #25224
7 years ago
Jordan Borean ad5fa60a2b Added initial developing module doc for Windows (#27308)
* Added initial developing module doc for Windows

* Added to dev index, made formatting changes and moved obsolete docs

* changes based on PR feedback

* some typos and extra information

* Minor updates

* minor wording clarifications
* remove references to "remote" Windows hosts
* update template/text to remove legacy `#WANT_JSON`/`#POWERSHELL_COMMON`
* use per-execution envvars for ANSIBLE_KEEP_REMOTE_FILES instead of stateful

* fix up minor sanity check issue
7 years ago
Matt Clay 51bd07204b Revert "Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)"
This reverts commit 520696fb39.
7 years ago
Toshio Kuratomi 520696fb39 Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)
* Revert "Update conventions in azure modules"

This reverts commit 30a688d8d3.

* Revert "Allow specific __future__ imports in modules"

This reverts commit 3a2670e0fd.

* Revert "Fix wildcard import in galaxy/token.py"

This reverts commit 6456891053.

* Revert "Fix one name in module error due to rewritten VariableManager"

This reverts commit 87a192fe66.

* Revert "Disable pylint check for names existing in modules for test data"

This reverts commit 6ac683ca19.

* Revert "Allow ini plugin to load file using other encoding than utf8."

This reverts commit 6a57ad34c0.
7 years ago
Toshio Kuratomi 3a2670e0fd Allow specific __future__ imports in modules
We do want to allow certain from __future__ imports in modules that make
it easier to code compatible python2 and python3.  Note that
unicode_literals is specifically left out and should never be allowed.
Now that python-3.4+ allows u"" there's no good reason to use
unicode_literals.

Also switch tables in the validate_modules documentation to simple table format
7 years ago
Yannig Perré 6a57ad34c0 Allow ini plugin to load file using other encoding than utf8.
- New option for ini plugins: encoding
  - Add a new option encoding to _get_file_contents
  - Use replace option in test/runner/lib/util.py when calling decode on stdout/err
    output when diff have non-utf8 sequences
7 years ago
Toshio Kuratomi bf42f94021 Fixes to pip with git install instructions
* use git+https:// in the example url because not everyone will have ssh
  keys registered on github
* Remove the link to the github tarballs as they do not work.  users can
  use releases.ansible.com instead.
7 years ago
scottb 058e67dcbe Minor edits. 7 years ago
Brian Coca 74e9e4bcbd updated --diff docs 7 years ago
David Moreau-Simard e2d874c744 Improve release and development cycle documentation
This commit:
- Adds a table highlighting the status of each version and provides
  a link to each major release's changelog
- Re-inforces how stable versions are maintained and for how long
- Moves this documentation out of the developer tree (this is
  interesting for users too!) while keeping a link there.
7 years ago
jokurz 732912b641 Add local_action example in case of multiple arguments (#26427)
* Add local_action example in case of multiple arguments

Add an example to show how local_action can be used in case of multiple arguments.

* Update playbooks_delegation.rst
7 years ago
Andrea Tartaglia 341cf290d3 Added become_exe and become_flags docs (#19554)
* Added become_exe and become_flags docs

* Minor edits
7 years ago
Martin Krizek 9c50933a80 docs: fix community meetings link (#27264) 7 years ago
Matt Davis 9986639681 various Windows/Azure roadmap updates 7 years ago
Abhijeet Kasurde 4fd7ab11ff Minor fix for typo - ismount to is_mount
Fix adds correction from ismount to is_mount filter in
playbooks_tests documentation.

Fixes: 27128

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Sam Doran dac519135d Change docs to reference BOTMETA.yml instead of MAINTAINERS.txt (#26912) 7 years ago
Sloane Hertel 7a8054812c updated roadmap (AWS) (#27011)
* update AWS roadmap

* Update ROADMAP_2_4.rst
7 years ago
Toshio Kuratomi f4bb71c0df Update roadmap with python3 status (#27171) 7 years ago
Matt Clay a53dabf664 Update testing progress on 2.4 roadmap. 7 years ago
Chris Alfonso c19d25cf67 Updating network roadmap segment to reflect any changes we decided (#27057)
upon during our 2.4 dev cycle.
7 years ago
rgm 13e7e00706 Fix double-quote chars in passwordstore examples (#27084)
Also add link to passwordstore.org and correct a typo.
7 years ago
Serge Bishyr 7694fd6f9f #27045 fix installation guide via apt (ubuntu) (#27049)
* #27045 fix installation guide via apt (ubuntu)

* Update intro_installation.rst

Re-added apt-get update as it is needed to get the latest package index from ppa:ansible/ansible
7 years ago
Adrian Likins 33a2d72290 Update facts/vault roadmap items (#27082)
* Update facts/vault roadmap items
7 years ago
James Mighion b8337ee9d3 New module aireos_command (#26769)
* Adding ciscowlc_command module and unit tests.

* Adding __init__.py for unit test.

* Fixing PEP8 W503.

* Renaming module from ciscowlc_command to aire_command.

* Renaming aire_command to aireos_command.
7 years ago
acrewdson 0a4c570153 Fix typo (#26988) 7 years ago
Ryan Brown beca565c79 [Docs] Add note on module development about the copyrights (#26812)
* Add note on module development about the copyrights

This matches what's in CODING_GUIDELINES.md as of July 2017

* Add recommendation for standardizing on `Copyright (c) 2017 Ansible Project`

* s/with/should have/

* Fix more unicode
7 years ago
James Mighion f682d9bf49 Adding aruba_command module along with unit tests. (#26625)
* Adding aruba_command module along with unit tests.

* Fixing PEP8 E303 too many blank lines.

* Adding default for timeout.

* Removing unused arguments. Moving default for timeout argument. Fixing cliconf to find hostname.

* Fixing PEP8 E302.
7 years ago
Toshio Kuratomi 37e757286d Add module_utils example next to library examples (#25390) 7 years ago
Dylan Silva 913a8f864a changed freeze date for modules (#27009) 7 years ago
Matt Clay 16f796460f Fix rstcheck issue. 7 years ago
Brian Coca 3477825fc9 updated roadmap 7 years ago
Matt Clay 8e66015564 Fix rst syntax in roadmap. 7 years ago
Adrian Likins 06e49dfbbd fix roadmap, strikethough does not quite work 7 years ago
Adrian Likins e6de059048 updating roadmap with facts status 7 years ago
Matt Clay e63f69464f Add ansible-test options and docs. (#26823)
* All integration commands support --continue-on-error
* The network-integration command supports --inventory
* Add landing page for compile test docs.
* Add bot documentation links.
7 years ago
Dylan Silva ba000abe1c Added in dates for freeze (#26814)
* Added in dates for freeze

* Update ROADMAP_2_4.rst
7 years ago
Matt Clay 789218c215 Initial ansible-test sanity docs. (#26775)
* Rename no-iterkeys test for consistency.

* Require docs for all ansible-test sanity tests.

* Initial ansible-test sanity docs.

* Fix capitalization of Python.

* Fix sanity code smell test false positives.

* Fix another code-smell false positive.
7 years ago
Lujeni 640131c464 Missing documentation about the include directive for requirements files (#20090)
* Missing documentation about the include directive for requirements files

* Code block needs blank line

* Correct casing
7 years ago
scottb 4f01a323a0 Replace 'simple module development' topic (#26267)
* WIP: Initial bulk move of quick start content into rst docs. Needs rewrite.

* Swapping out old quick start for new material (thanks @tstringer!). Still work in progress.

* Fixed formatting; removed extraneous file.

* Fixed some formatting errors.

* Once more, with feeling.

* Fixed formatting error
7 years ago
Pilou 2a92120ffa INI inventory plugin: add documentation about variable types (#25798)
* INI inventory: check variable types
* INI inventory: add doc about variable types

Fixes #25784
7 years ago
Pilou 4b3d6dfa8a Use pycodestyle instead of pep8 (#25947) 7 years ago
Dag Wieers cda6f602f1 Fix missing index (#26678) 7 years ago
Dag Wieers 292f109ad6 Restructure roadmap so that we can link to sub-parts (#26637)
* Restructure roadmap so that we can link to sub-parts

So we want to point to specific subsections in the roadmap from the Working Group pages.
This requires the use of subtitles rather than a long list of items and sub-items.

* RST syntax is hard...

* Fixes as requested

* Another fix

* Converted all ROADMAPs to new format
7 years ago
Dag Wieers 318f369969 filetree: Add documentation for lookup plugin (#26157)
* filetree: Add documentation for lookup plugin

This is the missing documentation for the filetree lookup plugin.

* Fix typo

* Edits for grammar and clarity
7 years ago
Chiyu Zhong 505dd9fe44 Update playbooks_loops.rst 7 years ago
John R Barker ed0aabe02d Tell people to look for an existing module PR (#26287)
* Tell people to look for an existing module PR

There are a number of different ways to find existing PRs that add new
modules. Tell people about them to potentially avoid duplicates.

* Light edits
8 years ago
Helio Campos Mello de Andrade 54c64deaab Remove unnecessary 'our"word. (#26221)
Remove unnecessary 'our"word.
8 years ago
Scott Butler ed17d7a0a5 Editing to fix wording from PR #26161. 8 years ago
Chainarong Tangsurakit ff30682740 [cloud][gce] Add necessary key for secrets.py (#25997)
Add necessary key for secrets.py
8 years ago
Sam Doran 6f73ab84c6 Correct note syntax so Docker on non-Linux note shows up (#26161)
The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML.

Also remove an unnecessary trailing colon.
8 years ago
Sam Doran 67eae347cd Fix roles language in docs (#25811)
* Correct tag behavior with regards to roles

* Remove trailing spaces

* Furthe clarify include vs. import tag behavior
8 years ago
Brian Coca 8bcfb85918 display v added 8 years ago
Laurens Vanderhoven 6922a18c80 Update playbook_best_practices.rst, range notation (#25959)
Update --limit range notation.

Current notation triggers "[WARNING]: Use [x:y] inclusive subscripts instead of [x-y] which has been removed"
8 years ago
John R Barker 4ab4a6766e ansible-windows IRC (#25872) 8 years ago
John R Barker 5551e87755 RETURNS can include version_added (#25810) 8 years ago
Simon Dodsley 937d7993cc Initial commit for Pure Storage Ansible module (#25386)
* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Fix import issues as required by post-2.2

* Move last import to top

* Follow suggestions and only implement one module per PR
Fix documentation changes requested

* Documentation and formatting changes
8 years ago
Matt Martz 89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 8 years ago
Sanket Jagtap dbb3fd0e5e Formatted Dynamic Inventory link for Openstack (#25351)
* Formatted Dynamic Inventory link for Openstack

* Create intro_dynamic_inventory.rst
8 years ago