patchback[bot]
04f36f0bac
[PR #8771/e3a3c6d5 backport][stable-9] ModuleHelper guide ( #8786 )
...
ModuleHelper guide (#8771 )
* initial commit
* fix initial version
* add quickstart and high-level outline
* MH guide progress
* MH guide progress (up to params,vars,output)
* adjustments
* MH guide progress (up to handling changes)
* MH guide progress (up to Exceptions)
* typo
* change section from note to important
* MH guide progress (added StateModuleHelper)
* minor improvement
* MH guide progress (added decorators)
* typo
* minor adjustments
* remove line
* complete MH guide
* adjustments
* adjustments
* change paragraph into seealso
* rearrange sections, plus wordsmithing
* adjustments
* wordsmithing
* fix references
(cherry picked from commit e3a3c6d58f
2024-08-21 16:10:32 +00:00
patchback[bot]
f6349578c6
[PR #8592/b0797d32 backport][stable-9] CmdRunner guide ( #8602 )
...
CmdRunner guide (#8592 )
* initial commit
* wip
* WIP
* progressing
* remove copied part
* progressing
* document as_func()
* complete docs about arg formatting
* add PythonRunner documentation
* fix markup
* improve markup
* multiple changes
- revamp the cmd_runner_fmt doc
- add CmdRunner instance and context parameters
- changed formatting of other blocks
* fix typo + reduce tables sizes
* improve text
* fixes and adjustments
* fix sanity
* fix version added
(cherry picked from commit b0797d329c
2024-07-08 22:25:23 +02:00
patchback[bot]
3a01ceb355
[PR #8482/caecb229 backport][stable-9] Feature. Add chapter 'Lists of dictionaries' to docsite ( #8582 )
...
Feature. Add chapter 'Lists of dictionaries' to docsite (#8482 )
* Feature. Add chapter 'Lists of dictionaries'
* Fix copyright and licensing.
* Add maintainers for docsite chapter 'Lists of dictionaries'.
* Generate docs keep_keys and remove_keys
* Update integration tests of keep_keys and remove_keys
* Update docs helpers of keep_keys and remove_keys
* Fix copyright and licensing.
* Fix remove license from templates. Cleanup.
* Add docs helper replace_keys
* Update integration test filter_replace_keys
* Generate and update:
filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst
* Formatting improved.
* Fix results Jinja quotation marks.
* Update docs/docsite/helper/keep_keys/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst.j2
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/helper/keep_keys/filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst.j2
Co-authored-by: Felix Fontein <felix@fontein.de>
* Fix references.
* Updated helpers.
* Fix licenses. Simplified templates.
* Fix licenses.
* Fix README.
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit caecb2297f
2024-07-05 08:53:55 +02:00
patchback[bot]
02de81c39e
[PR #8509/d95f4d68 backport][stable-9] fix version vardict was introduced ( #8511 )
...
fix version vardict was introduced (#8509 )
(cherry picked from commit d95f4d68a3
2024-06-15 11:52:12 +02:00
patchback[bot]
42175e38b2
[PR #8477/ac3c0435 backport][stable-9] Update docsite chapter "Merging lists of dictionaries" ( #8492 )
...
Update docsite chapter "Merging lists of dictionaries" (#8477 )
* Update docs 'Merging lists of dictionaries'
* Adding links to module and plugin options in
docs/docsite/helper/lists_mergeby
* Add subsections and improve formatting.
* Add example-009 'Merge single list'
* Fix licenses.
* Fix variables.
* Update docs/docsite/helper/lists_mergeby/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit ac3c04357c
2024-06-13 07:19:02 +02:00
patchback[bot]
71af3226f3
[PR #8460/a0ad2d58 backport][stable-9] add docs for the vardict module utils ( #8467 )
...
add docs for the vardict module utils (#8460 )
* add docs for the vardict module utils
* fix var name
* add entry to BOTMETA
* rollback adjustment in deps guide
* Update docs/docsite/rst/guide_vardict.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* adjustments
* Update docs/docsite/rst/guide_vardict.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit a0ad2d5849
2024-06-06 13:19:10 +02:00
patchback[bot]
86a2996814
[PR #8417/5a5188a4 backport][stable-9] deps module_utils: add docs ( #8450 )
...
deps module_utils: add docs (#8417 )
* add docs for the deps module utils
* wordsmithing
* fix reference and filename
* add entries to BOTMETA.yml
* Update docs/docsite/rst/moddev_guide_deps.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* adjust docs organisation
* adjust docs organisation II
* PR adjustments
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 5a5188a453
2024-06-02 00:25:24 +02:00
cfiehe
102a0857db
New filters to calculate the union, intersection, difference and symmetric difference of lists by preserving the items order ( #7985 )
...
New filters lists_union, lists_intersect, lists_difference and lists_symmetric_difference added.
Signed-off-by: Christoph Fiehe <c.fiehe@eurodata.de>
Co-authored-by: Christoph Fiehe <c.fiehe@eurodata.de>
2024-02-23 20:35:09 +01:00
Felix Fontein
838e4e3f02
Add Alicloud, Online, Packet, and Scaleway scenario guides ( #7714 )
...
* Add Alicloud, Packet, and Scaleway scenario guides.
These were taken from
3f12228c79/docs/docsite/rst/scenario_guides
2023-12-11 19:09:57 +01:00
Felix Fontein
2a7f9f28b9
Improve docsite extra docs ( #7444 )
...
* Improve markup.
* Improve filter and test guides by linking to plugins and using FQCNs more consistently.
* list_merge is an option, not the filter's name.
* Improve filter docs.
2023-10-30 21:54:58 +00:00
Felix Fontein
9327b12c4d
Add more default license and copyright notices ( #5087 )
...
* Add more default license and copyright notices.
* Fix tests.
* Fix typos.
* Fix task type.
* Add URL to changelog fragment.
* Improve headers for setup_wildfly_server.
2022-08-08 08:44:19 +02:00
Vladimir Botka
15f7e25b3c
Update docs helper. Automate generation of 'Merging lists of dictiona… ( #4125 )
...
* Update docs helper. Automate generation of 'Merging lists of dictionaries'.
* Updated helper/lists_mergeby/playbook.yml, list of examples and
templates. See playbook.yml on how to create *.out files, test
examples and generate the REST file
filter_guide_abstract_informations_merging_lists_of_dictionaries.rst
* Generated REST file copied to directory rst
* Simplified examples. The common lists are published only once. Only
the expressions are published instead of the whole tasks.
* To change the content of the section 'Merging lists of dictionaries'
update template
filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2
and run the playbook.
* Deleted rst/examples/lists_mergeby. Not needed anymore.
* Update docs/docsite/helper/lists_mergeby/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst.j2
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide_abstract_informations_merging_lists_of_dictionaries.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
2022-02-05 21:20:15 +01:00
Vladimir Botka
9c146787f5
Docs split filter guide ( #4103 )
...
* Update docs. Split fiter_guide.rst to files per sections.
* Fix docs.
* Update docs. Split filter_guide_abstract_informations.rst to files per sections.
* Create section 'Merging lists of dictionaries' from the template in helper/lists_mergeby.
* Fixed indentation. Comments and notes added.
* Revert "Fixed indentation. Comments and notes added."
This reverts commit 0f384508685b9d01ec2d
2022-01-31 05:55:23 +01:00
Vladimir Botka
71fb3984db
Add options to filter lists_mergeby ( #4058 )
...
* Update filter lists_mergeby #4057
* Added options 'recursive' and 'list_merge'. The functionality of the
added options is the same as in the filter 'combine'.
* Allow the user to do [list1, list2, ...]|lists_mergeby('index')
* Use the function merge_hash from ansible.utils.vars
* Add merge_hash_wrapper to test Ansible version
* Enable Ansible 2.9 and lower versions with default options of
lists_mergeby only.
* Non-default options of lists_mergeby trigger error in 2.9 and lower
versions.
* Update messages and tests.
* Fix tests.
* Use LooseVersion instead of SpecifierSet.
* Update docs 'Filter Guide' section 'Merging lists of dictionaries'.
* Added changelog fragment.
* Update changelogs/fragments/4058-lists_mergeby-add-parameters.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Added examples; moved to rst/examples; fixes.
* Improve error message testing sequence.
* Removed .yamllint
* Update docs/docsite/rst/examples/lists_mergeby/example-003.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/example-004.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/example-005.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/example-006.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/example-007.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update tests/integration/targets/filter_list/tasks/lists_mergeby_default.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/example-008.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Fix docs. Antsibull only copies .rst files.
* Fix examples in-line.
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/examples/lists_mergeby/examples.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs lists_mergeby. Remove rubbish.
* Emphasized labes of examples in filter_guide.rst
* Removed temporary file examples/lists_mergeby/examples.rst
* Removed tests/integration/targets/filter_list/runme.*
* Fix docs. Description of the lists_merge options.
* Move helper files out of rst/ directory.
Co-authored-by: Felix Fontein <felix@fontein.de>
2022-01-28 08:19:19 +01:00
Rémy Keil
9642a15d34
Add counter filter ( #3921 )
...
* Add counter filter
* move counter filter doc to existing chapter
* Use existing typerror exception from Counter
* Match counter filter example task name and output
2021-12-26 14:56:21 +01:00
Felix Fontein
c69810bf04
Add test plugin which allows to query whether a module or action plugin is available ( #3628 )
...
* Add test which allows to query whether an action is available.
* Add documentation.
* Fix FreeBSD / macOS compatibility.
* Rename an_action -> a_module.
* Forgot one place.
2021-11-01 19:00:24 +01:00
Ajpantuso
29e4066944
New filter plugin - unicode_normalization ( #3359 )
...
* Initial commit
* Adding maintainer in BOTMETA
* Adding changelog fragment
* Updating filter_guide
* Applying initial review suggestions
2021-09-12 13:46:53 +02:00
Felix Fontein
3516acf8d4
Add filter docs ( #2680 )
...
* Began with filter docs.
* Add more filters.
* Add time unit filters.
* Add TOC and filters to create identifiers.
* Add more filters.
* Add documentation from ansible/ansible for json_query and random_mac.
* Update docs/docsite/rst/filter_guide.rst
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-06-01 19:03:07 +02:00
