cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
37638 commits 47 branches 390 tags 440 MiB
Commit graph

1136 commits

Author SHA1 Message Date
Brian Coca
19fee0ef41 fix keyword doc generation 
* use aliases when they exist
  * fix hardcoded loop attributes handling
 2018-04-30 14:47:09 -04:00
Andrius Benokraitis
9773157da6 Update intermediate_concepts.rst (#39500) 
Updated  GitHub Repos section to better explain what ansible-network@redhat.com is for (not an email list, but adding to the network-automation github repo.
 2018-04-30 09:29:37 -05:00
Alicia Cozine
c8a9b411bc
Last docs link fixes (#39391) 
* should not need <>, but fails without

* adds anchor to keywords page, uses it on plugins pages

* fixes envvar link errors

* harmonize file name and ref name as python_3

* removes undefined-lable from ignore list
 2018-04-27 13:21:39 -05:00
Abhijeet Kasurde
9f1254a32f Typo fix in testing link (#39407) 
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
 2018-04-27 01:16:12 -07:00
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
Alicia Cozine
0fef3f1b48 avoids not-in-toc errors with :orphan: 2018-04-23 12:14:43 -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 5cf544e03e)
 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
John R Barker
ebdf6d0fab
Add missing > to fix 'edit this document' link (#39067) 2018-04-20 11:31:17 +01:00
Salvatore Mesoraca
aaf2ff629d Fix formatting error in rst plugin template (#38956) 
The hyperlink syntax used is wrong and the resulting
rendered documents have broken links.
 2018-04-20 13:48:28 +05:30
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
6ddc64bc7c Fixes for multiline doc descriotions breaking rst formatting 
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation
 2018-04-19 11:37:37 -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
Toshio Kuratomi
f9d83944ec regex for finding :ref: labels was flawed 
The regex to find labels inside of angle brackets was not detecting
anything before so I missed all of those.
* Fixed the regex in find-plugin-refs to take care of that.
* Fixed plugin_formatter to emit namespaced labels for the M() macro.
 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
Toshio Kuratomi
a1b148d190 Fix shebang so sanity tests pass 2018-04-17 15:01:29 -07:00
Toshio Kuratomi
1f0cc54ec7 fixup style problems in new script 2018-04-17 15:01:29 -07:00
Toshio Kuratomi
6b1e6b8460 Add a script for finding bare plugin :ref:s 
We're porting autogenerated plugin docs so that :ref: targets are
namespaced by plugin type.  To do this effectively, we need to know
where all the :ref: targets which refer to the bare plugin names are in
the rst files.  This script will find those.
 2018-04-17 15:01:29 -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
Toshio Kuratomi
25523666ce Modules that have a link to their own deprecated section need to use a different link syntax (#38697) 
The :ref: syntax is for linking to targets which are defined for the
whole document tree.  `link`_ is for linking to targets which are inside
of the document.  We want the latter for deprecated sections because
otherwise we'd have to create namespaced link targets for them.

Also fix expansion of version a deprecated module will be removed in
 2018-04-12 17:24:14 -07: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
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.
 2018-04-04 14:31:14 -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
Matt Martz
a89d0d0919
Ensure that arguments for sub commands are properly indented (#37992) 2018-04-03 10:56:12 -05: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
Joseph Herlant
00a7ff7974 Move man pages generations to rst2man (#37861) 2018-03-26 16:28:28 -07: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
Dag Wieers
69c0f96112 Fix nested parameters in module docs (#37793) 2018-03-22 14:33:51 -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