mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-05-07 13:32:37 +00:00
minor: doc: use the same style of version_added across repo (#703)
minor(doc): use the same style of version_added across repo SUMMARY Currently is no single style of version_added, in some places it's unquoted, somewhere single quote is used, in another places it's double quoted. Moreover, some file had different styles in one single file. The aim of this PR is to update whole repo to single style for version_added ISSUE TYPE Docs Pull Request COMPONENT NAME kustomize helm helm_info helm_plugin helm_plugin_info helm_pull helm_repository helm_template k8s_cluster_info k8s_cp k8s_drain k8s_exec k8s_log k8s_rollback k8s_taint ADDITIONAL INFORMATION The same style is proposed as used in amazon.aws collections Reviewed-by: Kelv Gooding Reviewed-by: Alina Buzachis Reviewed-by: Mike Graves <mgraves@redhat.com>
This commit is contained in:
committed by
GitHub
parent
ac943e9890
commit
6360763098
@@ -14,7 +14,7 @@ module: helm
|
||||
|
||||
short_description: Manages Kubernetes packages with the Helm package manager
|
||||
|
||||
version_added: "0.11.0"
|
||||
version_added: 0.11.0
|
||||
|
||||
author:
|
||||
- Lucas Boisserie (@LucasBoisserie)
|
||||
@@ -61,7 +61,7 @@ options:
|
||||
default: false
|
||||
type: bool
|
||||
aliases: [ dep_up ]
|
||||
version_added: "2.4.0"
|
||||
version_added: 2.4.0
|
||||
release_name:
|
||||
description:
|
||||
- Release name to manage.
|
||||
@@ -99,7 +99,7 @@ options:
|
||||
default: []
|
||||
type: list
|
||||
elements: str
|
||||
version_added: '1.1.0'
|
||||
version_added: 1.1.0
|
||||
update_repo_cache:
|
||||
description:
|
||||
- Run C(helm repo update) before the operation. Can be run as part of the package installation or as a separate step (see Examples).
|
||||
@@ -129,7 +129,7 @@ options:
|
||||
- string
|
||||
- json
|
||||
- file
|
||||
version_added: '2.4.0'
|
||||
version_added: 2.4.0
|
||||
reuse_values:
|
||||
description:
|
||||
- When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
|
||||
@@ -137,14 +137,14 @@ options:
|
||||
- If I(reset_values) is set to C(True), this is ignored.
|
||||
type: bool
|
||||
required: false
|
||||
version_added: '2.5.0'
|
||||
version_added: 2.5.0
|
||||
reset_values:
|
||||
description:
|
||||
- When upgrading package, reset the values to the ones built into the chart.
|
||||
type: bool
|
||||
required: false
|
||||
default: True
|
||||
version_added: '2.5.0'
|
||||
version_added: 2.5.0
|
||||
|
||||
#Helm options
|
||||
disable_hook:
|
||||
@@ -181,7 +181,7 @@ options:
|
||||
- similar to C(wait_timeout) but does not required C(wait) to be activated.
|
||||
- Mutually exclusive with C(wait_timeout).
|
||||
type: str
|
||||
version_added: "2.3.0"
|
||||
version_added: 2.3.0
|
||||
atomic:
|
||||
description:
|
||||
- If set, the installation process deletes the installation on failure.
|
||||
@@ -192,12 +192,12 @@ options:
|
||||
- Create the release namespace if not present.
|
||||
type: bool
|
||||
default: False
|
||||
version_added: "0.11.1"
|
||||
version_added: 0.11.1
|
||||
post_renderer:
|
||||
description:
|
||||
- Path to an executable to be used for post rendering.
|
||||
type: str
|
||||
version_added: "2.4.0"
|
||||
version_added: 2.4.0
|
||||
replace:
|
||||
description:
|
||||
- Reuse the given name, only if that name is a deleted release which remains in the history.
|
||||
@@ -205,19 +205,19 @@ options:
|
||||
- mutually exclusive with with C(history_max).
|
||||
type: bool
|
||||
default: False
|
||||
version_added: "1.11.0"
|
||||
version_added: 1.11.0
|
||||
skip_crds:
|
||||
description:
|
||||
- Skip custom resource definitions when installing or upgrading.
|
||||
type: bool
|
||||
default: False
|
||||
version_added: "1.2.0"
|
||||
version_added: 1.2.0
|
||||
history_max:
|
||||
description:
|
||||
- Limit the maximum number of revisions saved per release.
|
||||
- mutually exclusive with with C(replace).
|
||||
type: int
|
||||
version_added: "2.2.0"
|
||||
version_added: 2.2.0
|
||||
extends_documentation_fragment:
|
||||
- kubernetes.core.helm_common_options
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user