This is an automated email from the ASF dual-hosted git repository.
gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new c6ad9698 [hotfixt][docs] Remove all "simply/easily" usages
c6ad9698 is described below
commit c6ad96980278aa34864c33447e8c8aec3a6a5909
Author: Chesnay Schepler <[email protected]>
AuthorDate: Fri Oct 7 13:03:01 2022 +0200
[hotfixt][docs] Remove all "simply/easily" usages
---
docs/content/docs/custom-resource/job-management.md | 6 +++---
docs/content/docs/operations/configuration.md | 2 +-
docs/content/docs/operations/helm.md | 2 +-
docs/content/docs/operations/ingress.md | 2 +-
docs/content/docs/operations/metrics-logging.md | 4 ++--
docs/content/docs/operations/upgrade.md | 4 ++--
docs/content/docs/try-flink-kubernetes-operator/quick-start.md | 2 +-
7 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/content/docs/custom-resource/job-management.md
b/docs/content/docs/custom-resource/job-management.md
index ba76b9ea..b23880bc 100644
--- a/docs/content/docs/custom-resource/job-management.md
+++ b/docs/content/docs/custom-resource/job-management.md
@@ -63,7 +63,7 @@ The way state is handled for suspend and restore operations
is described in deta
**Cancelling/Deleting applications**
-As you can see there is no cancelled or deleted among the possible desired
states. When users no longer wish to process data with a given FlinkDeployment
they can simply delete the deployment object using the Kubernetes api:
+As you can see there is no cancelled or deleted among the possible desired
states. When users no longer wish to process data with a given FlinkDeployment
they can delete the deployment object using the Kubernetes api:
```
kubectl delete flinkdeployment my-deployment
@@ -155,9 +155,9 @@ Last state upgrade mode is currently only supported for
`FlinkDeployments`.
### Application restarts without spec change
-There are cases when users would simply like to restart the Flink deployments
to deal with some transient problem.
+There are cases when users would like to restart the Flink deployments to deal
with some transient problem.
-For this purpose you can use the `restartNonce` top level field in the spec.
Simply set a different value to this field to trigger a restart.
+For this purpose you can use the `restartNonce` top level field in the spec.
Set a different value to this field to trigger a restart.
```yaml
spec:
diff --git a/docs/content/docs/operations/configuration.md
b/docs/content/docs/operations/configuration.md
index 460120cb..81a2464c 100644
--- a/docs/content/docs/operations/configuration.md
+++ b/docs/content/docs/operations/configuration.md
@@ -32,7 +32,7 @@ The operator allows users to specify default configuration
that will be shared b
These configuration files are mounted externally via ConfigMaps. The
[Configuration
files](https://github.com/apache/flink-kubernetes-operator/tree/main/helm/flink-kubernetes-operator/conf)
with default values are shipped in the Helm chart. It is recommended to review
and adjust them if needed in the `values.yaml` file before deploying the
Operator in production environments.
-To append to the default configuration, simply define the `flink-conf.yaml`
key in the `defaultConfiguration` section of the Helm `values.yaml` file:
+To append to the default configuration, define the `flink-conf.yaml` key in
the `defaultConfiguration` section of the Helm `values.yaml` file:
```
defaultConfiguration:
diff --git a/docs/content/docs/operations/helm.md
b/docs/content/docs/operations/helm.md
index 58b83ae8..6a58e86f 100644
--- a/docs/content/docs/operations/helm.md
+++ b/docs/content/docs/operations/helm.md
@@ -180,7 +180,7 @@ spec:
```
## Advanced customization techniques
-The Helm chart does not aim to provide configuration options for all the
possible deployment scenarios of the Operator. There are use cases for
injecting common tools and/or sidecars in most enterprise environments that
simply cannot be covered by public Helm charts.
+The Helm chart does not aim to provide configuration options for all the
possible deployment scenarios of the Operator. There are use cases for
injecting common tools and/or sidecars in most enterprise environments that
cannot be covered by public Helm charts.
Fortunately, [post
rendering](https://helm.sh/docs/topics/advanced/#post-rendering) in Helm gives
you the ability to manually manipulate manifests before they are installed on a
Kubernetes cluster. This allows users to use tools like
[kustomize](https://kustomize.io) to apply configuration changes without the
need to fork public charts.
diff --git a/docs/content/docs/operations/ingress.md
b/docs/content/docs/operations/ingress.md
index 03df1964..92c5b4a1 100644
--- a/docs/content/docs/operations/ingress.md
+++ b/docs/content/docs/operations/ingress.md
@@ -105,5 +105,5 @@ NAMESPACE NAME CLASS HOSTS
ADDRESS PORTS AGE
default sample-job nginx * localhost 80 54m
```
The Flink Web UI can be accessed at https://localhost/default/sample-job/
->Note: All the examples were created on a minikube cluster. Check the
[description](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/)
for easily enabling the NGINX Ingress Controller on minikube.
+>Note: All the examples were created on a minikube cluster. Check the
[description](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/)
for enabling the NGINX Ingress Controller on minikube.
diff --git a/docs/content/docs/operations/metrics-logging.md
b/docs/content/docs/operations/metrics-logging.md
index 602f31eb..1478e92e 100644
--- a/docs/content/docs/operations/metrics-logging.md
+++ b/docs/content/docs/operations/metrics-logging.md
@@ -87,7 +87,7 @@ Some of these metrics are on system, namespace and resource
level.
The well known [Metric
Reporters](https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/metric_reporters)
are shipped in the operator image and are ready to use.
-In order to specify metrics configuration for the operator, simply prefix them
with `kubernetes.operator.`. This logic ensures that we can easily separate
Flink job and operator metrics configuration.
+In order to specify metrics configuration for the operator, prefix them with
`kubernetes.operator.`. This logic ensures that we can separate Flink job and
operator metrics configuration.
Let's look at a few examples.
@@ -189,7 +189,7 @@ To learn more about accessing the job logs or changing the
log level dynamically
### FlinkDeployment Logging Configuration
-Users have the freedom to override the default `log4j-console.properties`
settings on a per-deployment level by simply putting the entire log
configuration into `spec.logConfiguration`:
+Users have the freedom to override the default `log4j-console.properties`
settings on a per-deployment level by putting the entire log configuration into
`spec.logConfiguration`:
```yaml
spec:
diff --git a/docs/content/docs/operations/upgrade.md
b/docs/content/docs/operations/upgrade.md
index 53d2edbd..66bc8804 100644
--- a/docs/content/docs/operations/upgrade.md
+++ b/docs/content/docs/operations/upgrade.md
@@ -83,12 +83,12 @@ These changes require a one time manual upgrade process for
the running jobs.
### Upgrading without existing FlinkDeployments
-In an environment without any `FlinkDeployments` you simply need to uninstall
the operator and delete the v1alpha1 CRD.
+In an environment without any `FlinkDeployments` you need to uninstall the
operator and delete the v1alpha1 CRD.
```sh
helm uninstall flink-kubernetes-operator
kubectl delete crd flinkdeployments.flink.apache.org
-# Now simply reinstall the operator with the new v1beta1 version
+# Now reinstall the operator with the new v1beta1 version
```
### Upgrading with existing FlinkDeployments
diff --git a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
index f00f2960..17d76c64 100644
--- a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
+++ b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
@@ -123,7 +123,7 @@ kubectl port-forward svc/basic-example-rest 8081
Now the Flink Dashboard is accessible at
[localhost:8081](http://localhost:8081/).
-In order to stop your job and delete your FlinkDeployment you can simply:
+In order to stop your job and delete your FlinkDeployment you can:
```bash
kubectl delete flinkdeployment/basic-example
