1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

951 commits

Author SHA1 Message Date
Matt Clay
32d786af65 Convert more http links to https. 2018-04-25 23:12:46 -07:00
Lucid One
40fcef3e41 Adding support for opensearch of documentation (#38593) 2018-04-25 18:01:26 -07:00
Jordan Borean
f8853d83e3
windows: removed deprecated features in 2.6 (#38930)
* windows: removed deprecated features in 2.6

* Comma surgery.
2018-04-26 06:13:37 +10:00
Alicia Cozine
4b52a54e18 Reduce warnings (#39254)
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
2018-04-25 11:18:52 -07:00
Matt Martz
476d1f818e
Documentation for query/q. Fixes #38275 (#38558) 2018-04-25 12:55:34 -05:00
Matt Clay
7975c8fab0
Improve integration-aliases docs. (#39087) 2018-04-24 14:25:53 -07:00
Brian Coca
b533ebe20d
remove slice docs (#37946) 2018-04-24 11:11:46 -04:00
Andrius Benokraitis
7881866db4 Update ROADMAP_2_6.rst with additional network roadmap items (#39225)
* Update ROADMAP_2_6.rst

Added network_get and network_put to Network modules roadmap

* Update ROADMAP_2_6.rst

add netconf_config to the network module roadmap
2018-04-24 15:55:12 +01:00
Alicia Cozine
8f83061e70 corrects links to 'list_of' pages (#39161) 2018-04-24 15:51:12 +01:00
Alicia Cozine
becc2a0347 adds index page for roadmaps to support internal links (#39109)
* adds index page for roadmaps to support internal links

* includes only roadmaps index page in TOC
2018-04-23 12:22:44 -07:00
Matt Clay
c262dbfd30 Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
saichint
6eecbf10e6 fix nxos_igmp_interface issues (#38752)
* fix nxos_igmp_interface issues

* shippable fix

* fix oif_prefix and oif_source

* shippable fix

* shippable fix

* shippable fix

* add an example for oif_ps

* review comments

* review comments

* more review comments

* fix typo
2018-04-23 20:38:49 +05:30
Josh
aa9d7cb1f3 Update playbooks_debugger.rst (#39117)
Minor typo correction

+label: docsite_pr
2018-04-23 10:37:40 +02:00
Benn Roth
56967497d5 minor accuracy fix
Don't round the parameter 12.04 in the explanatory paragraph unless `version()` rounds the parameter

(cherry picked from commit 5cf544e03e5f833e1614fa940849976550d55448)
2018-04-20 19:14:39 -04:00
Alicia Cozine
bbfd6c6ab1 Internal refs (#39094)
* fixes community refs

* fixes appendix refs

* fixes scenario refs, keeps ACI guide link to devel

* fixes windows refs

* fixes user guide refs

* fixes dev guide refs
2018-04-20 12:17:02 -07:00
John R Barker
c4e298b808 Correct to development_process (#39069) 2018-04-20 12:36:29 -05:00
Matt Clay
9e8889bb70
Fix more docs errors. (#39051)
* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.
2018-04-20 00:24:47 -07:00
Matt Clay
7e96421132
Handle warnings in docs-build sanity test. (#39043) 2018-04-19 23:09:48 -07:00
Matt Clay
4fc5e89e83 Fix docs build warnings. 2018-04-19 17:54:56 -07:00
Alicia Cozine
64dcc7def0 Fixes more rST errors (#39042)
* removes include, avoids duplicate label rST warnings

* reduces literal_block errors on playbooks_filters

* addresses TOC errors

* ref error on modules page

* trying ref for list_of_database_modules
2018-04-19 17:02:48 -07:00
Alicia Cozine
408e29cbd2 Link fixes (#39038)
* fixes links on plugins pages

* fixes links in community pages

* fixes links in user guide

* adds anchors on playbooks pages
2018-04-19 17:02:30 -07:00
Toshio Kuratomi
a08459a814
Update info on python support (#38855)
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

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

  Fixes #21594

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

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

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

* Make wording for Solaris troubleshooting better.
2018-04-18 13:04:47 -07:00
Alicia Cozine
0ebc0b9e5a adds FAQ TOC entry, links & examples to modules (#38706)
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples
2018-04-18 11:41:54 -07:00
Toshio Kuratomi
8cdd75a09f Some more fixes for the docs :ref: disambiguation
The big one is that we needed to set plugin_type when we processed the by_support template.

Also added to list_of_CATEGORY_plugins page (which might not be used)
and corrected a place where I did module_name instead of name_module
2018-04-18 10:06:01 -07:00
Brian Coca
ce8c336d52 added ref to ansilbe molecule 2018-04-18 12:19:09 -04:00
Toshio Kuratomi
9faf7b949e Fix places in docs that refer to modules without namespace
We've namespaced all plugin docs.  Change the docs to reflect that
2018-04-18 08:43:34 -07:00
Martin Krizek
8173602a34
Add expandvars jinja2 filter (#38805)
* Add expandvars jinja2 filter

* Add docs

* Minor edit
2018-04-18 09:29:19 +02:00
scottb
c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.
2018-04-17 18:45:07 -07:00
Matt Clay
3d57f45815 Update httptester docs. 2018-04-17 15:02:56 -07:00
Evgeniy Komissarov
92f4065157 Fix typo in windows_faq.rst (#38864)
Fix typo in `python-pip` packet name.
+label: docsite_pr
2018-04-18 07:55:57 +10:00
John R Barker
3d3781db57
Correct formatting (#38874) 2018-04-17 13:19:04 +01:00
Brian Coca
bdbb89378f
centralize doc/config plugin lists (#38775)
* centralize doc/config plugin lists

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

* updated shell page to list plugins

added some more docs hinting at plugins being configurable

* fix edit link for plugins
2018-04-16 09:29:49 -04:00
Kenyon Ralph
3c6a362921 playbooks_async.rst: correct typo 2018-04-16 09:03:39 -04:00
Rémy Léone
d639d5dc96 Fix typo (#38652)
Typo
+label: docsite_pr
2018-04-13 14:15:26 -04:00
CsilLAB
521ea56e77 Add details to see decrypted vault value (#37341)
* Improves ansible-vault section of network getting started
2018-04-12 19:52:34 -05:00
Matt Clay
26fa3adeab Add docs-build sanity test. 2018-04-12 15:56:49 -07:00
Will Thames
4ba29c8bf1 Use a temp directory that is more likely to exist (#38645)
`env:SystemDrive\temp` does not necessarily exist

`env:temp` is much more likely to exist. Use that
2018-04-12 14:16:18 +10:00
Qasim Sarfraz
6d830166e9 Minor typo fix (#38589) 2018-04-12 13:47:48 +10:00
Evgeni Golov
7376a9b946 fix with_<lookup> spelling (#38584)
trivial change ;)

+label: docsite_pr
2018-04-11 15:37:33 -07:00
Alicia Cozine
da6d2b5f43 corrects Junos network_cli example & variables (#38601)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
2018-04-11 15:36:40 -07:00
Alicia Cozine
ea99cf3231 inaugural Network FAQ (#38359) 2018-04-11 15:35:42 -07:00
Martin Krizek
5297eac46d
playbooks_variables.rst: fix facts code-block (#38520) 2018-04-11 20:46:27 +02:00
Martin Krizek
f1e41cbb36
playbooks_intro.rst: remove duplicite playbook (#38521) 2018-04-11 20:45:59 +02:00
scottb
6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501) 2018-04-09 16:16:45 -07:00
alekseyp
061ecac3b5 Update playbooks_loops.rst (#38440)
Missing parentheses
+label: docsite_pr
2018-04-09 12:49:34 +02:00
Pierre Templier
1e0df01980 Small typos in docs (#38371)
* Small typos in docs

* Use same wording as in porting_guide_2.5.rst
2018-04-09 12:49:10 +02:00
Abhijeet Kasurde
8bc7af2e34 Minor typo in installation guide (#38452)
Change subsription-manger to subscription-manager

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-04-08 14:41:59 -07:00
scottb
d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 2018-04-07 16:37:54 -07:00
Will Thames
a8953fcac4 Add documentation on dict2items (#38375)
dict2items is worth mentioning in the filters and loops pages
(the latter as it's useful to replace `with_dict`)

Update some nearby broken links
2018-04-07 02:13:19 -07:00
scottb
785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 2018-04-06 20:34:31 -07:00
Toshio Kuratomi
f1b63f435e The ssh change note has been removed
Since the note was about 2.0 versus 1.x, this has been removed.  The
file implementing it is gone so we need to stop referencing it.
2018-04-06 12:04:19 -07:00
scottb
2381d2207e
Additional docs CSS fix for mobile (#38376) 2018-04-05 23:59:18 -07:00
scottb
79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 2018-04-05 23:20:24 -07:00
Pierre Templier
2340ca7701 Small typos in docs (#38370)
* Small typos in docs

* Fixed wording
2018-04-05 22:20:51 -07:00
Elijah Lynn
95d40bcd0a Update fish setup to use source instead of . (#33207)
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."

source: https://fishshell.com/docs/current/commands.html#source
2018-04-05 11:51:55 -07:00
Brian Coca
c62551c1b0 Update role doc examples (#37844)
* fix role examples

- also fixed issue with overload of 'name', fixes #37836
- attempted to clarify tag inheritance/application

* Typo fix
2018-04-05 11:41:25 -07:00
Brian Coca
5ad13d66aa documented actual precedence (#38009)
fixes #22025
2018-04-05 11:09:11 -07:00
Christian Fetzer
9cca9a9c10 docs: Document disabling diff on task level (#37998)
* docs: Document disabling diff on task level

Tasks that deal with secrets may leak sensitive information when
running in Check Mode. This change updates the documentation explaining
that the diff can be deactivated on task level.

The feature was requested in #14860 and got introduced in Ansible 2.4
with #28581.

* Updated for clarity
2018-04-05 11:08:30 -07:00
Pilou
2a604f6fe6 doc: index_var: fix version added (#37982)
e9b0a4ccb4 is present since v2.5.0b1
2018-04-05 11:06:14 -07:00
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
2018-04-05 11:05:38 -07:00
Dag Wieers
cdf9e39647 Fix the automatic docsite_pr label (#37999) 2018-04-05 10:48:37 -07:00
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.
2018-04-05 10:46:46 -07:00
ewubnhn
ea9ece8e72 Update spelling_word_choice.rst (#38113)
Added missing format string on "Installer"

 label: docsite_pr
2018-04-05 10:45:42 -07:00
Alicia Cozine
24fe8674a6 DOCS: Network Best Practices fixes (#38293)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649
2018-04-05 10:44:27 -07:00
Scott Butler
62c2b9a544 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. 2018-04-04 20:36:01 -07:00
Toshio Kuratomi
4165bb308b Fix 2.5 changelog link 2018-04-04 14:39:38 -07:00
Toshio Kuratomi
73c80862c8 Update docs and version definitions for the 2.4.4 and 2.5.0 releases 2018-04-04 14:21:04 -07:00
Dylan Silva
45b5a486c6 2.6 roadmap doc (#37926)
* 2..6 roadmap doc

* Formatting & network items

* typo
2018-04-04 18:26:19 +01:00
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
2018-04-04 09:50:29 -07:00
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 2018-04-03 17:13:29 -07:00
Dag Wieers
70d49f7616
Fix indentation issue
<!--- Your description here -->

+label: docsite_pr
2018-04-03 10:45:50 +02:00
Sam Doran
b5b3beff83 Correct syntax highlighting in plugin dev docs (#38184)
Use rst em dash
2018-04-02 15:39:20 -07:00
Daniel
45e4dfda3d doc: fix grammar (#38145) 2018-03-30 18:32:29 +02:00
Alicia Cozine
b72960fdd4
revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
2018-03-27 14:59:04 -05:00
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".
2018-03-27 08:15:30 -04:00
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
2018-03-26 12:15:32 -05:00
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav (#37864) 2018-03-23 17:55:29 -07:00
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) 2018-03-23 17:36:56 -07:00
Pilou
56d0721bd9 doc: modules involving file transfert bypass pipelining (#37250)
* doc: modules involving file transfert bypass pipelining

* Fixed typo
2018-03-23 07:02:19 -05:00
Martin Krizek
bcfff1c818 docs: needs_rebase is still used (#37774) 2018-03-23 00:51:53 -07:00
Brian Coca
8b45cab3c1
document our deprecation (#37788)
* document our deprecation

fixes #37779

* Copy edit.
2018-03-22 16:15:02 -04:00
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
2018-03-22 09:37:14 -04:00
Brian Coca
40a55e9f55 update vars info (#37729)
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
2018-03-22 00:02:45 -07:00
Ryan Pineo
fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 2018-03-22 00:00:23 -07:00
scottb
57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically (#37661) 2018-03-20 12:15:15 -07:00
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
2018-03-20 12:00:34 -07:00
Brian Coca
64dfaf9cda removed deffered items (#37541) 2018-03-19 01:05:34 -07:00
Michael
7fd74c2089 Fix typo in inventory docs (#37577) 2018-03-19 01:04:29 -07:00
scottb
0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 2018-03-16 21:35:41 -07:00
Arbab Nazar
775e8ed806 fix the typo
<!--- Your description here -->

 label: docsite_pr
2018-03-16 16:26:13 -04:00
Dag Wieers
3cc362d958
Add missing YAML escape characters
These were missing after review PR #37486

 label: docsite_pr
2018-03-15 21:06:16 +01:00
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>
2018-03-15 01:23:34 -07:00
Robert de Bock
0cf2ecbc62 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
2018-03-14 17:02:51 -04:00
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
2018-03-14 12:44:21 -07:00
Toshio Kuratomi
fafcb3452f
Porting guide (#37226)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.
2018-03-08 16:02:43 -08:00
Alexander Lex
19f92005b9 Update developing_api.rst (#37108)
Fix for #17716 and #36110
2018-03-08 10:48:48 +00:00
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
2018-03-07 21:21:56 -05:00
John R Barker
ff28429e2a
Network doc items that are done 2018-03-07 11:37:43 +00:00
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.
2018-03-06 16:28:06 -08:00
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
2018-03-06 10:46:19 +00:00
John R Barker
7a4e270ae0
Link to new network platform pages (#37057)
Also fix a few broken links
2018-03-06 09:32:26 +00:00
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.
2018-03-05 16:14:27 -08:00
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
2018-03-06 00:05:13 +01:00
John R Barker
985f09270d
Ability to link to other pages from plugin docs (#37009)
Support relative links
2018-03-05 15:16:58 +00:00
scottb
e7f9c5cc60 Copy edits and tweaks 2018-03-02 18:14:07 -05:00
Brian Coca
cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
2018-03-02 18:14:07 -05:00
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
2018-02-28 16:01:18 -08:00
Russ Starr
4a6758b74f Update playbooks_filters_ipaddr.rst (#36883)
Fixed a typo since the example should be referencing the newly defined list.
2018-03-01 09:25:40 +10:00
Alicia Cozine
4f63123320
Network Platform docs (#36814)
* introduces platform docs
2018-02-28 15:16:32 -06:00
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.
2018-02-28 21:14:57 +00:00
John R Barker
41c066eff9
Fix broken links (#36864) 2018-02-28 15:54:58 +00:00
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>
2018-02-28 13:28:38 +00:00
John R Barker
3911b9c53a
typo 2018-02-28 12:41:16 +00:00
John R Barker
b3c64ecd09
khjh
j
2018-02-28 12:40:31 +00:00
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
2018-02-27 18:40:24 +00:00
Wolfgang Felbermeier
9c81b5d92b Fix table display width. (#36728) 2018-02-26 14:24:34 -08:00
Brian Coca
7a81d5f11e removed now irrelevant section
fixes #35760
2018-02-26 14:25:43 -05:00
Matt Clay
3937082892 Fix rst link syntax. 2018-02-26 11:17:43 -08:00
Kevin Breit
487ff1fe9b Fix typos (#36671)
Fix minor typos
2018-02-26 11:24:53 +00:00
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
2018-02-25 19:13:16 +01:00
Dag Wieers
97fde8c760
ACI: Asorted fixes to documentation (#36681) 2018-02-24 22:50:54 +01:00
Dag Wieers
e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 2018-02-24 21:45:25 +01:00
Dag Wieers
5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 2018-02-24 17:16:40 +01:00
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
2018-02-24 14:06:12 +01:00
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 !
2018-02-24 03:57:37 +01:00
Dag Wieers
fde4cc6219
guide_aci: Fix a few references (#36666) 2018-02-24 01:47:44 +01:00
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.
2018-02-24 00:38:50 +01:00
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
2018-02-23 17:10:47 -06:00
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
2018-02-23 09:51:36 -06:00
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>
2018-02-23 10:46:31 +00:00
Alicia Cozine
51a010a696 Network Getting started docs (#36337)
* first draft of getting started guide
2018-02-22 20:43:04 +00:00
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
2018-02-21 19:35:59 +01:00
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.
2018-02-20 12:12:12 -08:00
Matt Lee
75ab070c63 Update vault.rst (#36328)
hunter2 not hunter42. http://bash.org/?244321
2018-02-20 12:11:32 -08:00
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
2018-02-19 20:40:25 +05:30
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
2018-02-19 12:01:14 +01:00
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
2018-02-16 18:26:07 +00:00
Brian Coca
3eff279dd7 updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit
2018-02-16 10:04:10 -08:00
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
2018-02-15 23:54:45 -08:00
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
2018-02-15 20:34:40 +00:00
John R Barker
577ff4d949
Add stub porting_guide_2.6.rst (#36190)
* Add stub porting_guide_2.6.rst

* Typo fix
2018-02-15 07:29:15 +00:00
scottb
1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 2018-02-14 23:14:22 -08:00
scottb
391896ca9d
Fixed typo in link. (#36220) 2018-02-14 18:37:03 -08:00
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
2018-02-14 15:40:35 -08:00
Brian Coca
0cf70a8970
never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit
2018-02-14 17:01:36 -05:00
scottb
c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 2018-02-14 14:00:18 -08:00
scottb
dc902a5022
Fixes broken nested tables in module docs (#36144) 2018-02-13 15:21:10 -08:00
Brian Coca
28015d8ae9 ensure cli dir exists before saving files to it 2018-02-13 17:43:26 -05:00
Brian Coca
5a0f4f0646 removed gnerated files
@dharmabumstead, probably need a few more of these
2018-02-13 15:47:31 -05:00
Patrick Fink
43eb97ef92 Fix typo in vars.rst (#35098) 2018-02-13 15:05:11 -05:00
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.
2018-02-13 10:52:13 -08:00
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
2018-02-13 07:23:55 -08:00
John R Barker
480a9c10c9
Consistant headings (#36112) 2018-02-13 14:43:16 +00:00
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
2018-02-13 13:54:44 +01:00
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
2018-02-13 03:13:08 +01:00
Matt Davis
5f68892e81
requested status updates/removals of punted items 2018-02-12 10:37:04 -08:00
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
2018-02-11 00:32:22 -08:00
John R Barker
c3523cdd60
Test against a single transport (#35903)
Network integration tests can use tags to run only a specific transport
2018-02-09 16:07:41 +00:00
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
2018-02-09 17:03:39 +01:00
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
2018-02-08 12:41:25 -05:00
Brian Coca
07221d777a
Better document connection: local (#34462)
* Better document connection: local

* Attempt at clear wording.

* Fixed spacing
2018-02-07 16:17:57 -05:00
Brian Coca
297eab5073 move away from bad inline var defs
partial fix for #35714
2018-02-07 16:17:01 -05:00
Martin Krizek
4319947e60
Remove jinja native types from roadmap (#35444) 2018-02-07 17:00:16 +01:00
Ganesh Nalawade
1d068d4af9 Update network section in 2.5 porting guide (#35643)
* Update 2.5 porting guide with network module_utils move
2018-02-06 15:35:59 -06:00
Dag Wieers
67c217398c
Add initial ACI guide (#35364)
* Add initial ACI guide

* Implement all review suggestions
2018-02-06 11:44:32 +01:00
Marc Mercer
6bd4803c80 Fixing syntax for mail callback doc (#35379) 2018-02-05 23:14:08 -08:00
Andrew Gaffney
e9b0a4ccb4 Add support for defining index var for task loops 2018-02-05 22:14:05 -05:00
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.
2018-02-05 18:49:02 -07:00
Joshua Smith
cee5d420de Add examples for OpenBSD hosts. (#35691)
* Add examples for OpenBSD hosts.

* Incorporate changes recommended based on feedback from my pull request.
2018-02-05 18:21:45 -05:00
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
2018-02-05 13:32:06 -08:00
Matt Martz
975f4def78
Tags on includes only affect the include. FIxes #35729 (#35732) 2018-02-05 09:53:56 -06:00
Joshua Smith
5c2783c161 Update example syntax in playbooks_tests.rst. (#35688) 2018-02-05 14:14:15 +00:00
Joshua Smith
f1d0279921 Update example syntax in test_strategies.rst, (#35689) 2018-02-05 14:13:00 +00:00
Ivan Bojer
196f2f382b removed panos_nat_policy (#34432)
* removed panos_nat_policy

* merge

* removed extra line
2018-02-03 11:35:17 +00:00
Joshua Smith
e1c9c6eded Update example syntax in playbooks_tags.rst. (#35680) 2018-02-03 11:33:02 +00:00
Joshua Smith
060890f3b2 Update example syntax in playbooks_loops.rst. (#35679) 2018-02-03 11:32:11 +00:00
Joshua Smith
aeb749e116 Update example syntax in playbooks_lookups.rst. (#35678) 2018-02-03 11:31:12 +00:00
Joshua Smith
1b7e5d19a2 Update example syntax in playbooks_intro.rst. (#35677) 2018-02-03 11:30:54 +00:00
Joshua Smith
0a5ff792e4 Update example syntax in playbooks_filters.rst. (#35676) 2018-02-03 11:30:24 +00:00
Joshua Smith
6179bd378c Update example syntax in playbooks_error_handling.rst. (#35675) 2018-02-03 11:29:58 +00:00
Joshua Smith
3fe6de475b Update example syntax in playbooks_delegation.rst. (#35674) 2018-02-03 11:29:40 +00:00
Joshua Smith
203c8f4334 Update example syntax in playbooks_conditionals.rst (#35673) 2018-02-03 11:29:22 +00:00
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.
2018-02-03 11:28:22 +00:00
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.
2018-02-02 18:20:03 +00:00
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>
2018-02-02 20:03:57 +05:30
jctanner
4ec16867fd Fix loop/with typo in loops doc (#35652) 2018-02-02 13:33:13 +00:00
René Moser
785e888ea0 doc: fix loop examples (#34991) 2018-02-02 13:52:28 +01:00
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
2018-02-02 12:35:02 +00:00
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
2018-02-02 12:21:21 +00:00
Joshua Smith
0c012703c1 Update developing inventory script docs. (#35639)
* Update developing inventory script docs.

* Copy edit.
2018-02-02 02:03:17 -08:00
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)
2018-01-31 14:56:28 -06:00
Toshio Kuratomi
0b4debad53 Update the release doc with ansible-2.4.3 2018-01-31 12:30:11 -08:00
Alicia Cozine
9dad5d6b7f creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
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
2018-01-31 09:57:05 -08:00
John R Barker
06734f27c6
Network Doc status (#35475)
Plus remove trailing whitespace
2018-01-31 09:04:06 +00:00
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
2018-01-30 17:31:10 -08:00
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.
2018-01-30 09:09:41 -06:00
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()
```
2018-01-30 12:23:52 +00:00
Jordan Borean
4da19f2d6b Added code-smell check to verify filenames are allowed with Windows (#35436) 2018-01-29 13:46:02 -08:00
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.
2018-01-29 11:47:06 +10:00