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

295 commits

Author SHA1 Message Date
Alicia Cozine
9d5b5d7ddd
correct description of modules vs plugins (#55784) 2019-04-26 09:32:42 -05:00
Sandra McCann
cca365061c
add how to create HttpApi plugins for network modules (#54340)
* initial port over from gdoc

* crosslink httpapi pages

* Add some examples?

* Add quick example of using Connection

* Fix indentation of python code blocks

* moved to a full developer guide for networks

* Try to clarify some examples

* Fix typos

How did I even do that?
2019-04-22 13:21:21 -04:00
Gregor Dschung
158452661a Correct link to Thomas' GitHub account (#55587)
Thomas renamed his account from tstringer to trstringer
2019-04-22 09:37:00 -05:00
Alicia Cozine
d7f6493084 adds better links to tips and pitfalls page (#55458) 2019-04-17 14:30:34 -04:00
Matt Martz
9f83139dcb
Don't register tests as filters (#55332)
* Don't register tests as filters. Fixes #55319

* Remove tests for deprecated functionality

* Remove no-tests-as-filters sanity tests

* Remove docs too

* Revert "Remove docs too"

This reverts commit 7daf457a742e67ec6e91964852c7f804507b46b8.

* Make no-tests-as-filters doc an orphan
2019-04-16 14:10:14 -05:00
Kevin Breit
521e62aa38 Update set_module_args in unit test docs (#55244)
* Update docs/docsite/rst/dev_guide/testing_units_modules.rst
`set_unit_args()` should be imported and used in the unit test documentation. 

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
2019-04-15 17:27:27 -05:00
Kevin Breit
a005dcfbbd Add example for full path on unit tests (#55243)
Docs: adds an example when a full path is needed for unit tests, with module_utils, etc.
2019-04-15 16:20:14 -05:00
Abhijeet Kasurde
3003954415 Update unit testing docs (#55272)
* Updated links
* Updated indentation
* Fixed typos

Fixes: #55242

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-04-15 14:27:06 -05:00
Sandeep Kasargod
e1c4ee2514 New module for managing volumes in Vexata storage arrays (#49006)
* Initial commit for module to manage Vexata storage volumes + fixes form code review in pr #47091.

* Fix indent errors reported by lint.

* Refactor, implement code review changes

* Moved doc fragment file to new layout

* Added explicit types for all module parameters, updated copyrights + raw string for block text.
2019-04-10 21:12:23 +05:30
ximon18
7474e39c37 Rewrote one awkward sentence. (#54892)
Rewrote awkward sentence in the developing inventory guide.

+label: docsite_pr
2019-04-05 14:25:50 -05:00
Daniel Hagan
e114d06801 Minor formatting fix in developing_modules_documenting.rst (#54785)
* developing_modules_documenting.rst - fix formatting error

* developing_modules_documenting.rst - remove errant whitespace from last commit
2019-04-04 08:52:31 +01:00
dthvt
ea2fa07e23 AnsibleModule uses supports_check_mode (#54629)
<!--- Your description here -->

Looks like AnsibleModule uses supports_check_mode, not check_mode.

+label: docsite_pr
2019-04-02 13:46:06 -05:00
Brian Coca
6f77dbf66f update _facts and _info in checklist (#54182)
* update _facts and _info in checklist in docs/docsite/rst/dev_guide/developing_modules_checklist.rst

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>
2019-03-21 12:49:28 -05:00
Matt Clay
39bbadb2fd
Replace no-underscore-variable test with pylint. (#54140)
* Replace no-underscore-variable test with pylint.
* Update orphan handling for sanity test docs.
* Update command for listing tests.
2019-03-20 22:14:22 -07:00
Jill R
3e670373e0 Add returned keys to example module (#53884) 2019-03-20 16:22:49 +00:00
Abhijeet Kasurde
9018819023
Update Testing page for OS version (#53800)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-03-15 11:35:39 +05:30
David Passante
40af4a144d Update an example in documentation fields (#53760)
According to the `Linking within module documentation` section, the right syntax should be `I(state=present)`.
2019-03-14 19:14:08 -05:00
Gonéri Le Bouder
6421e89e23 docs: refresh testing_integration.rst (#53338)
* docs: refresh testing_integration.rst

Ensures the examples can be run:
- fedora25 is not available anymore, use fedora29 instead
- the posix/ci alias does not exist anymore, use shippable/posix/ instead
- explain how to list the target without argcomplete

* ansible-test should be in $PATH
* call ansible-runner from bin/, not test/runner
* we don't use credentials.template anymore, we use a collection of .template files.
* low-case bash bc we refresh to name of the binary
* refresh the command of Windows-CI example
* Update docs/docsite/rst/dev_guide/testing_integration.rst

Co-Authored-By: goneri <goneri@lebouder.net>
2019-03-07 20:43:04 -06:00
Brian Coca
c0a4cf297d add '_facts' rule to module checklist (#53359)
* add '_facts' rule to module checklist

* Update docs/docsite/rst/dev_guide/developing_modules_checklist.rst

Co-Authored-By: bcoca <bcoca@users.noreply.github.com>
2019-03-06 15:52:12 -05:00
Gonéri Le Bouder
0b579a0837 doc: preseve block-quote structure (#53293)
Without the `::`, the indentation of the example block is lost.
2019-03-06 13:45:22 -05:00
Sloane Hertel
9687879840
Fix inventory cache interface (#50446)
* Replace InventoryFileCacheModule with a better developer-interface

Use new interface for inventory plugins with backwards compatibility

Auto-update the backing cache-plugin if the cache has changed after parsing the inventory plugin

* Update CacheModules to use the config system and add a deprecation warning if they are being imported directly rather than using cache_loader

* Fix foreman inventory caching

* Add tests

* Add integration test to check that fact caching works normally with cache plugins using ansible.constants and inventory caching provides a helpful error for non-compatible cache plugins

* Add some developer documentation for inventory and cache plugins

* Add user documentation for inventory caching

* Add deprecation docs

* Apply suggestions from docs review

* Add changelog
2019-03-06 12:12:35 -06:00
Xaroth
646a8586a5 Remove old 'srtd' theme and references. (#49289) 2019-03-05 12:22:17 -06:00
Matt Martz
a639dc6d88
Add a new check to ensure that module arguments are valid python identifiers (#53278)
* Add a new check to ensure that module arguments are valid python identifiers

* Move the check up higher, out of the if docs block

* Skip validate-modules on py2

* Remove errant alias
2019-03-05 10:26:06 -06:00
Chris Gavin
43042682e8 Fix an incorrect function call in a documentation example. (#53233) 2019-03-04 07:27:24 -06:00
Sebastian Wojciechowski
5cc6a70398 Remove redundant article in testing integration note (#53209) 2019-03-04 07:21:10 -06:00
Kevin Breit
4af5842409 Developer documentation - Change path to connection_plugins (#52577)
* Change path to connection_plugins

* Update docs/docsite/rst/dev_guide/developing_plugins.rst

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
2019-02-27 11:53:39 -06:00
Jordan Borean
7360db5956 doc - skip/windows for integration tests (#53010) 2019-02-26 15:41:46 -06:00
John R Barker
80cc6417fa Docs: List of Sanity Tests (#52986)
* Improve sanity test docs, how to run sanity tests section
2019-02-26 11:27:39 -06:00
Esa Varemo
5bdc6636bc Fix the example plugin paths (#52881)
Based on https://docs.ansible.com/ansible/latest/reference_appendices/config.html
the default callback paths do not contain `_plugin`. Thus `~/.ansible/plugins/callback_plugins` and `/usr/share/ansible/plugins/plugin_type/action_plugins` are incorrect. Verified on 2.7.5 that by default `plugins/action` works and `plugins/action_plugins` does not.
2019-02-25 15:35:34 -06:00
Divided by Zer0
1f06b3ca7d ungrouped as a list (#50593)
* update the developing_inventory docs to show ungrouped as a dict with a "children" key; avoid 
[WARNING]: Found both group and host with same name: ungrouped
2019-02-22 14:57:35 -06:00
Abhijeet Kasurde
e0d8d9c2bf validate-modules: Documentation bool (#50085)
* validate-modules: Documentation bool

This check allows to catch cases where type of argument is different than documentation does.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Wrong comparison for 'str'

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Add ignore.txt

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Fix logic and clean up ignore.txt
2019-02-15 14:27:52 -08:00
Jordan Borean
de118734e9
Ansible.Basic - add required_by to module spec (#51407)
* Ansible.Basic - add required_by to module spec

* fix typo in docs
2019-02-15 13:00:25 +10:00
James Cassell
953058d025 standardize connection variable names (#51776)
* standardize user/password connection vars

* docs: use ansible_user and ansible_password

* docs: var precedence for connection vars

* docs: ansible_become_pass -> ansible_become_password etc
2019-02-11 10:43:10 -05:00
Richard Diphoorn
ad549e375a Changed 'Control Machine' to 'Control Node' (#51696)
* Changed 'Control Machine' to 'Control Node' in the documentation. Changing the term 'Control Machine' to 'Control Node', to be in line with the basic concepts here: https://docs.ansible.com/ansible/latest/network/getting_started/basic_concepts.html

Also for both entities; Control/Managed using the same common denominator 'Node' brings consistency.

* Updated reference links to new term.
2019-02-08 13:40:09 -06:00
RMuskovets
eb54dab362 Update developing_rebasing.rst (#51650) 2019-02-08 13:29:39 -06:00
Toshio Kuratomi
dfd8b659c0 Have update-bundled check for updates to all bundled code
Add a test for whether we have bundled code inside of ansible that needs to be updated
2019-02-06 13:59:55 -08:00
Alex Willmer
c7f8e5d05e doc: Correct path of unit tests directory (#51631)
+label: docsite_pr
2019-02-02 00:59:13 +01:00
Wojciech Sciesinski
fbbda7267b Add a missed command (#50781)
* Add a missed command

* Link to the WinRM configuration page
2019-02-01 12:46:24 +10:00
Mahendra Yadav
10a402a9c8 Update developing_modules_general_windows.rst (#51493)
<!--- Your description here -->
Typo fix
+label: docsite_pr
2019-01-30 10:16:32 -06:00
Felix Fontein
f6122fb63b Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ...

* Fix unreachable/failed output lexing.

* Detecting retry/--limit lines.

* Removing strange (invisible) characters which cause lexing problems.

* Using better-fitting lexers.

* Improve YAML lexing: don't accept quotes in keys.

* Add Django lexer (unchanged) from Pygments.

* Add support for != and % operators.
2019-01-24 16:09:41 -06:00
Brian Coca
96b3ef5553
Doc fragments to plugins (#50172)
* promote doc_fragments into actual plugins

  change tests hardcoded path to doc fragments
  avoid sanity in fragments
  avoid improper testing of doc_fragments
  also change runner paths
 fix botmeta
 updated comment for fragments
 updated docs
2019-01-23 20:03:47 -05:00
Ken Dreyer
1b09197244 doc: describe merging to ansible.module_utils.* (#51152)
Add a section to the documentation describing precisely how Ansible
merges custom module_utils/* Python code into the "ansible.module_utils"
namespace.
2019-01-23 13:52:16 -06:00
Dag Wieers
1fb2165bd8
Fix typo
+label: docsite_pr
2019-01-22 15:45:01 +01:00
Matt Martz
ab0985a83a
Update the example for API use to reflect new context object (#50723) 2019-01-21 11:21:06 -06:00
Miguel Gonzalez
8546273f5e Make module handle its own exit (#50728) 2019-01-18 12:03:59 -05:00
Dag Wieers
7a1ceb6988
Correct the command for test coverage
+label: docsite_pr
2019-01-16 14:42:01 +01:00
Dag Wieers
9e003d702f
Fix relative paths
+label: docsite_pr
2019-01-16 00:26:07 +01:00
Matt Clay
560e922440 Add more ansible-test aliases to test docs. (#50921) 2019-01-15 22:02:43 +01:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" (#50929) 2019-01-15 14:53:04 +01:00
branen
88029a73d6 Correct docsite typos: it's -> its (#50812) 2019-01-11 15:49:54 -05:00