From 32c4ac8449233e59f561167faabe7adf46faf645 Mon Sep 17 00:00:00 2001 From: Suraj Deshmukh Date: Thu, 24 Jun 2021 19:58:20 +0530 Subject: [PATCH] chore(docs): fix bunch of typos (#347) Signed-off-by: Suraj Deshmukh --- deploy/crds/all_cstor_crds.yaml | 6 ++--- deploy/csi-operator.yaml | 4 ++-- deploy/helm/charts/Chart.yaml | 2 +- deploy/helm/charts/README.md | 2 +- deploy/helm/charts/crds/cstorvolume.yaml | 2 +- .../helm/charts/crds/cstorvolumereplica.yaml | 4 ++-- deploy/helm/charts/crds/volumesnapshot.yaml | 6 ++--- deploy/helm/charts/values.yaml | 2 +- docs/api-references/apis.md | 22 +++++++++---------- 9 files changed, 25 insertions(+), 25 deletions(-) diff --git a/deploy/crds/all_cstor_crds.yaml b/deploy/crds/all_cstor_crds.yaml index 8bf88c66..961fb6b5 100644 --- a/deploy/crds/all_cstor_crds.yaml +++ b/deploy/crds/all_cstor_crds.yaml @@ -2432,7 +2432,7 @@ spec: properties: logicalReferenced: description: LogicalReferenced describes the amount of space - that is "logically" accessable by this snapshot. This logical + that is "logically" accessible by this snapshot. This logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that application see. It also includes space consumed by metadata. @@ -2455,7 +2455,7 @@ spec: properties: logicalReferenced: description: LogicalReferenced describes the amount of space - that is "logically" accessable by this snapshot. This logical + that is "logically" accessible by this snapshot. This logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that application see. It also includes space consumed by metadata. @@ -2717,7 +2717,7 @@ spec: description: Mode represents replica status i.e. Healthy, Degraded type: string quorum: - description: 'Quorum indicates wheather data wrtitten to the + description: 'Quorum indicates whether data wrtitten to the replica is lost or exists. "0" means: data has been lost( might be ephimeral case) and will recostruct data from other Healthy replicas in a write-only mode 1 means: written data diff --git a/deploy/csi-operator.yaml b/deploy/csi-operator.yaml index 76bb1061..1014ee33 100644 --- a/deploy/csi-operator.yaml +++ b/deploy/csi-operator.yaml @@ -642,7 +642,7 @@ spec: format: date-time type: string error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurrs during the snapshot creation. Upon success, this error field will be cleared. + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. properties: message: description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' @@ -741,7 +741,7 @@ spec: format: date-time type: string error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurrs during the snapshot creation. Upon success, this error field will be cleared. + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. properties: message: description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' diff --git a/deploy/helm/charts/Chart.yaml b/deploy/helm/charts/Chart.yaml index b837e289..04e211fd 100644 --- a/deploy/helm/charts/Chart.yaml +++ b/deploy/helm/charts/Chart.yaml @@ -4,7 +4,7 @@ description: CStor-Operator helm chart for Kubernetes type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. -version: 2.10.1 +version: 2.10.2 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. appVersion: 2.10.0 diff --git a/deploy/helm/charts/README.md b/deploy/helm/charts/README.md index 4de9b914..05b9b354 100644 --- a/deploy/helm/charts/README.md +++ b/deploy/helm/charts/README.md @@ -220,7 +220,7 @@ helm install openebs-cstor openebs-cstor/cstor --namespace openebs --create-name | openebs-ndm.helperPod.image.registry | string | `nil` | Registry for helper image | | openebs-ndm.helperPod.image.repository | string | `openebs/linux-utils` | Image repository for helper pod | | openebs-ndm.ndm.filters.enableOsDiskExcludeFilter | bool | `true` | Enable filters of OS disk exclude | -| openebs-ndm.ndm.filters.enableVendorFilter | bool | `true` | Enable filters of venders | +| openebs-ndm.ndm.filters.enableVendorFilter | bool | `true` | Enable filters of vendors | | openebs-ndm.ndm.filters.excludeVendors | string | `"CLOUDBYT,OpenEBS"` | Exclude devices with specified vendor | | openebs-ndm.ndm.filters.enablePathFilter | bool | `true` | Enable filters of paths | | openebs-ndm.ndm.filters.includePaths | string | `""` | Include devices with specified path patterns | diff --git a/deploy/helm/charts/crds/cstorvolume.yaml b/deploy/helm/charts/crds/cstorvolume.yaml index e1abc5c7..ac9dd22d 100644 --- a/deploy/helm/charts/crds/cstorvolume.yaml +++ b/deploy/helm/charts/crds/cstorvolume.yaml @@ -194,7 +194,7 @@ spec: description: Mode represents replica status i.e. Healthy, Degraded type: string quorum: - description: 'Quorum indicates wheather data wrtitten to the + description: 'Quorum indicates whether data wrtitten to the replica is lost or exists. "0" means: data has been lost( might be ephimeral case) and will recostruct data from other Healthy replicas in a write-only mode 1 means: written data diff --git a/deploy/helm/charts/crds/cstorvolumereplica.yaml b/deploy/helm/charts/crds/cstorvolumereplica.yaml index edc7b40a..ff60226d 100644 --- a/deploy/helm/charts/crds/cstorvolumereplica.yaml +++ b/deploy/helm/charts/crds/cstorvolumereplica.yaml @@ -127,7 +127,7 @@ spec: properties: logicalReferenced: description: LogicalReferenced describes the amount of space - that is "logically" accessable by this snapshot. This logical + that is "logically" accessible by this snapshot. This logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that application see. It also includes space consumed by metadata. @@ -150,7 +150,7 @@ spec: properties: logicalReferenced: description: LogicalReferenced describes the amount of space - that is "logically" accessable by this snapshot. This logical + that is "logically" accessible by this snapshot. This logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that application see. It also includes space consumed by metadata. diff --git a/deploy/helm/charts/crds/volumesnapshot.yaml b/deploy/helm/charts/crds/volumesnapshot.yaml index 0afda9c9..b229db9c 100644 --- a/deploy/helm/charts/crds/volumesnapshot.yaml +++ b/deploy/helm/charts/crds/volumesnapshot.yaml @@ -91,7 +91,7 @@ spec: format: date-time type: string error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurrs during the snapshot creation. Upon success, this error field will be cleared. + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. properties: message: description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' @@ -190,7 +190,7 @@ spec: format: date-time type: string error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurrs during the snapshot creation. Upon success, this error field will be cleared. + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. properties: message: description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' @@ -223,4 +223,4 @@ status: conditions: [] storedVersions: [] ---- \ No newline at end of file +--- diff --git a/deploy/helm/charts/values.yaml b/deploy/helm/charts/values.yaml index fab990fe..154fb865 100644 --- a/deploy/helm/charts/values.yaml +++ b/deploy/helm/charts/values.yaml @@ -187,7 +187,7 @@ csiNode: # memory: 32Mi ## Labels to be added to openebs-cstor-csi-node pods podLabels: {} - # kubeletDir path can be configured to run on various different k8s ditributions like + # kubeletDir path can be configured to run on various different k8s distributions like # microk8s where kubelet root dir is not (/var/lib/kubelet/). For example microk8s, # we need to change the kubelet directory to `/var/snap/microk8s/common/var/lib/kubelet/` kubeletDir: "/var/lib/kubelet/" diff --git a/docs/api-references/apis.md b/docs/api-references/apis.md index 03d67a61..bdcafebc 100644 --- a/docs/api-references/apis.md +++ b/docs/api-references/apis.md @@ -1663,7 +1663,7 @@ uint64

LogicalReferenced describes the amount of space that is “logically” -accessable by this snapshot. This logical space ignores the +accessible by this snapshot. This logical space ignores the effect of the compression and copies properties, giving a quantity closer to the amount of data that application see. It also includes space consumed by metadata.

@@ -2078,7 +2078,7 @@ Kubernetes core/v1.ResourceList

(Appears on: -CStorVolumePolicy, +CStorVolumePolicy, CStorVolumeConfigSpec)

@@ -2226,7 +2226,7 @@ include space consumed by metadata

(Appears on: -CStorVolumeSpec, +CStorVolumeSpec, CStorVolumeStatus)

@@ -2810,7 +2810,7 @@ It may contain several volumes

(Appears on: -CStorPoolInstanceSpec, +CStorPoolInstanceSpec, PoolSpec)

@@ -3073,7 +3073,7 @@ Any power of 2 from 512 bytes to 128 Kbytes is valid.

(Appears on: -CStorPoolInstanceSpec, +CStorPoolInstanceSpec, PoolSpec)

@@ -3181,7 +3181,7 @@ string

(Appears on: -CStorVolumeStatus, +CStorVolumeStatus, CVStatus)

@@ -3280,7 +3280,7 @@ string -

Quorum indicates wheather data wrtitten to the replica +

Quorum indicates whether data wrtitten to the replica is lost or exists. “0” means: data has been lost( might be ephimeral case) and will recostruct data from other Healthy replicas in a write-only @@ -3438,10 +3438,10 @@ If left empty, no priority class is applied.

(Appears on: -CStorPoolCluster, -CStorPoolInstance, -CStorVolume, -CStorVolumeConfig, +CStorPoolCluster, +CStorPoolInstance, +CStorVolume, +CStorVolumeConfig, CStorVolumeReplica)