7bfeed3e24
Docsite: replace Latin phrases to English ( #71588 )
...
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases.
* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
4 years ago
0a7ab396c7
filters: minor doc fix ( #71178 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
8c48366f1c
Document to_json will convert to ASCII strings by default ( #70954 )
...
... as reported in issue #68702
4 years ago
7a42d27462
Proper example for splitext filter in docs ( #70494 )
...
* Update playbooks_filters.rst with a clear example of how to extract its 2 tokens.
Co-authored-by: Sloane Hertel <shertel@redhat.com>
4 years ago
db354c0300
Docs: User guide overhaul, part 5 ( #70307 )
4 years ago
f7db428375
update documentation link to python 3 ( #70509 )
...
update the docs link for strftime on the filters page to point to the python3 docs
4 years ago
4e41e37aa7
Fix flatten null perserve versionadded ( #70435 )
4 years ago
7a15a3a109
fix flatten handling of nulls/nones ( #70141 )
...
* fix flatten loop control issue (break -> continue)
fix issue #69012
(cherry picked from commit 2127be5ec5fixes #69012
fixes #69013
Co-authored-by: pseudocoder <borisovano@users.noreply.github.com>
Co-authored-by: David Shrewsbury <Shrews@users.noreply.github.com>
4 years ago
c89f3cda9e
incorporate minimalism feedback on filters page ( #70366 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
b491f776b9
doc: avoid mix of single and double quotes ( #70115 )
...
Avoid mix of single and double quotes in the `ternary`, this way
we can copy/past the example without any surprise.
4 years ago
5885ed4455
remove gendered example ( #70117 )
...
Changed example to not assume things about names and genders
4 years ago
6fffb0607b
WIP: Docs: User guide overhaul, part 4 ( #69266 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
44a4538280
add FQCN for migrated filters ( #69321 )
4 years ago
e867535a57
regex_replace multiline support ( #65051 )
...
* document multiline parameter for regex_replace
* add changelog fragment
* tests for regex_replace_multiline
5 years ago
423a900791
Clarify b64encode with Python 2 ( #67488 )
5 years ago
53e043b5fe
combine filter: fine list handling (option b) ( #57894 )
5 years ago
4273e84962
Upstream jinja has decided not to rename from jinja2. ( #66880 )
...
So we're going to keep our intersphinx labels as jinja2 to match what
upstream is doing
5 years ago
14cc63dc0f
Switch intersphinx label from jinja2 to jinja ( #66703 )
...
* Switch intersphinx label from jinja2 to jinja
Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
5 years ago
d3e9ef3c35
add a path_join filter which joins path components ( #62713 )
5 years ago
f85d9d7028
Correct rst syntax in playbooks_filters.rst ( #66198 )
...
The `regex_replace` documentation included an example that was meant
to be preformatted text but due to an indentation error was rendering
incorrectly.
5 years ago
860cacc54f
Docs: User guide overhaul, part 2 ( #65474 )
5 years ago
3af1732bd8
fix rendering of GOOD/BAD code for regex_replace examples ( #65654 )
...
adds double colon (::) so the examples render as code
5 years ago
21bbf49396
Mention Python builtin methods in filter docs ( #65425 )
5 years ago
39ebd244e3
Update playbooks_filters.rst ( #64769 )
5 years ago
e65be0beee
Put all files and Path filters under a specific section ( #64913 )
...
Many of the filters in the "other useful filters" list manipulate filenames and paths; add a heading and put them together.
5 years ago
2444fae208
Add a named parameter to the filter to_uuid ( #64057 )
...
Let the caller choose a namespace for `to_uuid` and document the
behaviour of both the default case, and the new explicit case.
This PR does not change the existing behaviour of the `to_uuid` UUIDv5
filter.
5 years ago
c8315bfd60
Prefer https:// links in the docs site ( #62939 )
...
This is a follow-up of last year's 1a11cec
5 years ago
b33ae14949
doc: fix typos ( #62852 )
5 years ago
11be31db71
Fix naming discrepancy in zip filter example ( #60918 )
...
Fix naming discrepancy in zip filter example
5 years ago
6131de29d4
Improve regex_replace filter docs ( #57450 )
...
* Add a few examples of how to correctly use `regex_replace` filter
because it behaves differently on different Python versions when using
regex qualifiers that can match an empty string (e.g. '*', '?', etc).
5 years ago
c06f890f55
add docs for vlan_parser filter ( #57498 )
5 years ago
bf0e846a39
Update playbooks_filters.rst ( #57200 )
...
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
5 years ago
730456b402
Add seed parameter to random_mac filter ( #51841 )
5 years ago
e55e8fe2c4
regex_escape: support POSIX basic regex ( #50327 )
6 years ago
07cff73719
Fix yaml indentation for from_yaml_all filter example ( #51998 )
6 years ago
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.
6 years ago
88029a73d6
Correct docsite typos: it's -> its ( #50812 )
6 years ago
13d94ed681
Update filter documentation ( #50255 )
...
Added documentation for following filters -
* Product
* human_readable
* human_to_bytes
Signed-off-by: Satyajit Bulage <sbulage@redhat.com>
6 years ago
b0c28f86de
Revert range change ( #50155 )
...
* Revert "Fix incorrect examples with random filter (#50137 )"
This reverts commit 9a7dbd5213#27215 )"
This reverts commit ea2b89c7ae
6 years ago
9a7dbd5213
Fix incorrect examples with random filter ( #50137 )
6 years ago
79947245e2
docs: remove not implemented password_hash feature ( #49945 )
6 years ago
960ebd981f
k8s append_hash ( #48830 )
...
* Add append_hash functionality to k8s module
append_hash adds a hash based on the contents of a ConfigMap
or Secret to the name - this enables immutable ConfigMaps and
Secrets.
* Provide k8s_config_resource_name plugin
The k8s_config_resource_name filter plugin provides a means of determining
the name of ConfigMaps and Secrets created with append_hash
* Add changelog fragment
* fix failing tests
* Update openshift version needed for append_hash
6 years ago
cc5b9c5fe1
enchance yaml filter documentation ( #46629 )
...
* update to_*_yaml filter documentation
* update to*_yaml filter documentation
6 years ago
e1cfc2500c
Clean playbook filters doc by adding whitespaces ( #46569 )
6 years ago
92037679c4
Fix subelements example correctly ( #46482 )
6 years ago
641c569a20
Fix spelling error in subelements Filter example ( #46446 )
...
<!--- Your description here -->
+label: docsite_pr
6 years ago
065b7ac300
moved 'strftime' filter into 'Other Useful Filters' section ( #45801 )
6 years ago
1e68881c40
adds support for null values to the ternary filter ( #45303 )
...
* adds support for null values to the ternary filter
This change adds a third optional argument to the ternary filter to
handle a null value. If the third option is specified null and false
are treated differently.
For instance, take the following example:
{{ enabled | ternary('no shutdown', 'shutdown') }}
If enabled == True, then 'no shutdown' is used.
If enabled in (False, None), then 'shutdown' is used.
With this change the following is possible:
{{ enabled | ternary('no shutdown', 'shutdown', omit) }}
If enabled == True, then 'no shutdown'
If enabled == False, then 'shutdown'
If enabled == None, then omit
* update documentation with example of filter
* update filter documentation example per comments
* fix logic error in user_guide example
6 years ago
c41632fad2
Add the key_name/value_name options to the dict2items filter ( #45550 )
...
* Add the key_name/value_name options to dict2items - as with items2dict, allow users to configure the key/value name for dict2items, add "version added" and examples
6 years ago
e35c4be1c1
Change "Defaulting Undefined Variables" ( #41379 )
...
Rewording the text for the second parameter of default because the original text was misunderstandable. +label: docsite_pr
6 years ago
Andrew Klychkov