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

1568 commits

Author SHA1 Message Date
Dag Wieers
ee29ba5d4f plugin_formatter.py: Improve the output when processing docs (#46541)
* Improve the output when processing files

* Update docs/bin/plugin_formatter.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Show progress indicator.

* Don't pp.pformat() huge structures when they aren't used anyway.

This saves ~10 seconds on my machine.

* Only show ASCII spinner if stdout is a TTY.

* Fix: E722 do not use bare 'except'
2018-12-18 11:23:49 -06:00
Dag Wieers
9bc401a272 Remove older version_added information from docs (#50097) 2018-12-18 10:50:07 -06:00
Sandra McCann
b873f34ea3 link to KB article -certified modules (#50050) 2018-12-17 16:27:28 -06:00
Dag Wieers
653c3da500 Fix document references in modules (#49892)
* Docs: Fixes internal module reference syntax for seealso
* Updates anchors and links
* Updates seealso in the docs for module **win_chocolatey**.
2018-12-17 10:20:06 -06:00
Jeffrey Reeves
1e647db8dc Redacted IP addresses under SSH_CLIENT & SSH_CONNECTION (#49991) 2018-12-17 09:01:53 -06:00
Toshio Kuratomi
3fba006207 Update bare exceptions to specify Exception.
This will keep us from accidentally catching program-exiting exceptions
like KeyboardInterupt and SystemExit.
2018-12-16 15:03:19 -08:00
Martin Krizek
79947245e2 docs: remove not implemented password_hash feature (#49945) 2018-12-14 17:45:07 -06:00
Matt Martz
67ce743cc9 Remove erroneous extra-vars example, and a few really old versionadded indicators. Fixes #38415 (#49955) 2018-12-14 17:09:25 -06:00
Alicia Cozine
90a6771bc8
removes space from example of L(link) syntax (#49908) 2018-12-14 09:15:57 -06:00
Jordan Borean
8d008fed35
windows dev docs: fix a few issues and add missing info (#49836) 2018-12-14 06:00:36 +10:00
Brian Coca
f645680fee corrected docs on args 2018-12-13 10:56:33 -05:00
Jordan Borean
190d1ed7f1 win become: refactor and add support for passwordless become (#48082)
* win become: refactor and add support for passwordless become

* make tests more stable

* fix up dep message for Load-CommandUtils

* Add further check for System impersonation token

* re-add support for become with accounts that have no password

* doc fixes and slight code improvements

* fix doc sanity issue
2018-12-12 17:15:25 -08:00
Alicia Cozine
bd1e566c8f
link from API stub page to module_utils page (#49831) 2018-12-12 14:20:42 -06:00
Dag Wieers
baf0ad2309 Docs: Add a "seealso" section to the module docs (#45949)
* Docs: Add a separate  "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.

So you can add a section in your module documentation and four types of
references are possible.

    seealso:

    # Reference by module name
    - module: aci_tenant

    # Reference by module name, including description
    - module: aci_tenant
      description: ACI module to create tenants on a Cisco ACI fabric.

    # Reference by rST documentation anchor
    - ref: aci_guide
      description: Detailed information on how to manage your ACI infrastructure using Ansible.

    # Reference by Internet resource
    - name: APIC Management Information Model reference
      description: Complete reference of the APIC object model.
      link: https://developer.cisco.com/docs/apic-mim-ref/

This PR also includes:

- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
  - This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)

* Use latest stable instead of devel docs
2018-12-12 14:19:58 -06:00
Bianca Henderson
52843fcabc Making changes to the Community Guide index (#49670) 2018-12-12 13:49:00 -06:00
Humberto Nanni
128760cc47 Update intro_installation.rst (#49756)
directions to install ansible on CLR Linux
2018-12-12 13:17:43 -06:00
Pierre-Louis Bonicoli
7e278b23b4 inventory plugin order: update doc
add doc for #44428:
- add changelog fragment
- update porting guide
also:
- update auto inventory plugin doc
- mention toml plugin in examples
2018-12-12 09:35:13 -08:00
Evgeni Golov
32dbb99bb8 plugin_formatter.py: accept multiple template dirs (#49765)
this allows to override certain templates without copying the whole
template directory
2018-12-11 16:19:40 -05:00
Pilou
1bad617f29 Inventory plugins move auto before ini (#44428)
* inventory plugins: try auto before ini

auto plugin should run before ini to avoid ini being able to parse
some plugin configuration YAML files successfully.

* Update comment

comment was added by 2ffe3c42bb but
related code was later removed by
506e6a0b2d.
2018-12-11 15:17:05 -05:00
Abhijeet Kasurde
eb61d26a2a Add missing parameter in virtualenv command (#49675)
Fixes: #43115

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-10 16:43:33 -06:00
Alicia Cozine
a71cd49a0c Style guide index (#49746)
* First revision of ansible style guide index page
2018-12-10 15:32:45 -05:00
Sandra McCann
32c2b3b3be Styleguide basic (#49747)
* cleaned up basics page

* made codeblock visible

* added anchor
2018-12-10 14:30:34 -06:00
Andreas Krüger
18bf48cec2 Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 2018-12-10 09:17:15 -06:00
Alicia Cozine
ef34b7cb83
fixes typo in windows usage guide (#49672) 2018-12-08 13:42:39 -06:00
Tim Burke
2b347d01fd Clean up some roadmap dates (#49630)
- Add year to the 2.1 roadmap.
- Move 2.6 final release from expected to actual timeline.
  As expected, v2.6.0 was tagged Jun 28.
2018-12-07 16:56:44 -06:00
trogdor_the_burninator
b3c277decc [FIX] grammatical structure of phrase (#49660) 2018-12-07 16:55:45 -06:00
Phuurl
29c96d20fb Corrects minor typos in the documentation (#49668)
Signed-off-by: Phuurl <chubble.10@icloud.com>
2018-12-07 16:54:32 -06:00
Matt Martz
9007dbec2f
Add info about loop based on jinja2 loop var (#42134)
* Add info about loop based on jinja2 loop var

* ansible_loop

* Update test count

* Add extended loop_control that defines whether ansible_loop should be added

* Extended needs to be defaulted

* Revert "Update test count"

This reverts commit f1e93ee469825f4cdcd90fb28667d29aa088275c.

* Add docs about loop_control.extended

* Add revindex and revindex0

* Document ansible_loop in special vars

* Add changelog fragment

* Add tests, change items to allitems so that dot notation works, fix logic error with previtem
2018-12-07 13:49:50 -06:00
Matt Martz
3a4d476512
Add now() jinja2 global func for getting the date/time (#43792)
* Add now() jinja2 global func for getting the date/time

* Docs and changelog

* now isn't a lookup, it doesn't need disabled
2018-12-07 11:25:53 -06:00
Tim Burke
6e43f9fe8f Fix ReST formatting for Galaxy docs link (#49575) 2018-12-06 11:06:46 -05:00
Chris St. Pierre
63b7882cbb Deprecate the github_hooks module (#49296)
It was super incomplete, and the interface was pretty strange; it had
built-in features to handle pretty bespoke workflows ("clean504",
e.g.) but was lacking lots of other useful features (like the ability
to create a webhook with a shared secret). Rather than try to update
the interface in a backwards compatible way, I've replaced it with the
more predictable, single-purpose github_webhook and
github_webhook_facts modules.
2018-12-06 15:56:53 +00:00
Pilou
7fd8d8d8c7 doc: fix link to ansible-config (#49597) 2018-12-06 10:00:48 -05:00
Toshio Kuratomi
bd7322a3f6 Simplify FactCache.update()
We only need FactCache.update() for the backwards compatibility shim as
MutableMapping.update() will do the right thing.
2018-12-05 12:33:27 -08:00
Toshio Kuratomi
33f0c1ce22 FactCache changes
* Fix FactCache to conform to the dict API
  * update needs to take a dict rather than a key and a value
  * __init__ needs to allow for setting the intial dictionary
* Remove unneeded _display and _cache attributes
* Move ansible.plugins.cache.FactCache to
  ansible.vars.fact_cache.FactCache because this isn't part of the cache
  plugin API.
* Add backwards compatibility when calling update on the new FactCache
* Remove code for calling old FactCache. There's no way to call the old
  FactCache so there's no need for backwards compatible code for calling
  code.  Backwards compatibility is handling things which are calling
  the new FactCache.
* Port our code to the new FactCache location.
2018-12-05 12:33:27 -08:00
Abhijeet Kasurde
8db7fcf45c ipaddr: Add missing documenation about network/prefix filter (#49532)
* ipaddr: Add missing documenation about network/prefix

Fixes: #17871

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-05 12:14:13 -05:00
Abhijeet Kasurde
287a42eba0 Added recommendation about module name (#49540)
* Added recommendation about module name

Added general guidelines for naming a module.

Fixes: #19665

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-05 10:30:40 -05:00
mbk87
95d810ab94 apt over apt-get (#47663)
* apt over apt-get

* added note on apt-get for older versions
2018-12-05 09:14:48 -05:00
Dag Wieers
257a8af922
Fix typo
Fix a small typo

+label: docsite_pr
2018-12-05 03:20:10 +01:00
owenmann
23637aa349 Update faq.rst: typo (#49491)
* Update faq.rst

<!--- Your description here -->
minor: typo

+label: docsite_pr
2018-12-04 15:44:29 -05:00
Martin Krizek
d20d66dc2f docs: try to clarify handlers a bit more (#49322)
* docs: try to clarify handlers a bit more
* docs: refines description of duplicate handler names
2018-12-03 15:21:59 -06:00
Alicia Cozine
8d01e26d18 Refines docs on creating action plugins (#49392)
* Refines docs on creating action plugins

Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
2018-12-03 10:44:15 -05:00
John R Barker
092f75cee4 Only one strategy_plugins page (#49442) 2018-12-03 20:35:01 +05:30
Abhijeet Kasurde
45e41f5a3d Add Action plugin example (#49290)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-30 15:53:38 -06:00
XOmniverse
5c525f9466 Update intro_inventory.rst to show YAML ranges (#49265)
Adds a YAML example inventory listing a range of hosts to complement existing INI example.
2018-11-30 14:29:57 -06:00
Ian Wienand
44c734e624 Local test docs: correct tox shell command usage (#49350)
The ansible-test shell command doesn't have a --python option; you
have to specify the tox environment directly to the --tox command

Partially fixes: #49349
2018-11-30 13:16:01 -06:00
Chris Archibald
73348ae32d Fixes for na_ontap_cluster_peer (#48329)
* Fixes for na_ontap_cluster_peer, incorporating review comments, version, etc.
2018-11-29 16:22:02 -06:00
Jordan Borean
d9ca78c542 update docs on runas become (#48149)
* update docs on runas become
* Added example win_whoami output and removed some 2.5 mentions
2018-11-29 16:17:59 -06:00
Kevin Breit
a9d68f3d52 Meraki scenario guide - describe how to merge new data with old data (#48999)
* Described how to merge new data with old data in the Meraki guide
Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
2018-11-29 15:42:10 -06:00
Alicia Cozine
02baae6e99 revises inventory intro page (#49330)
* revises inventory intro page

* changes :doc: to :ref: for links
2018-11-29 16:33:29 -05:00
Alicia Cozine
e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00