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

999 commits

Author SHA1 Message Date
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
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
Dag Wieers
629278464f Improve contribute-message in document footer (#36841) 2018-02-28 09:21:24 -08:00
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.
2018-02-28 17:16:18 +00:00