ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
37248 commits 10 branches 167 tags 272 MiB
Commit graph

1102 commits

Author SHA1 Message Date
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
Ryan Pineo
fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 2018-03-22 00:00:23 -07:00
Brian Coca
06b70f1614 Revert "Add a few Jinja2 tests to simplify template (#37514)" 
This reverts commit b8e07f0d6e.
 2018-03-20 18:20:43 -04:00
Dag Wieers
b8e07f0d6e
Add a few Jinja2 tests to simplify template (#37514) 
Add list test to simplify template
 2018-03-20 23:08:55 +01: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
Dag Wieers
e691e07646 Fix boolean input and string-type validation 2018-03-15 12:39:39 -07: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
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
 2018-03-12 13:50:52 -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
Dag Wieers
8f2c87231f Ensure the table spans the complete page width (#37129) 2018-03-08 10:48:42 -08:00
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
 2018-03-08 10:48:15 -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
0a2dda2060
Support <hr/> in module docs (#37030) 2018-03-05 19:18:24 +00: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
Dag Wieers
6601e78dfa
Wrong syntax 2018-03-01 03:07:03 +01: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