Skip to content

Commit

Permalink
chore(docs): fix bunch of typos (#347)
Browse files Browse the repository at this point in the history
Signed-off-by: Suraj Deshmukh <[email protected]>
  • Loading branch information
surajssd committed Jun 24, 2021
1 parent a930469 commit 32c4ac8
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions deploy/crds/all_cstor_crds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions deploy/csi-operator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
Expand Down Expand Up @@ -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.'
Expand Down
2 changes: 1 addition & 1 deletion deploy/helm/charts/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion deploy/helm/charts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion deploy/helm/charts/crds/cstorvolume.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions deploy/helm/charts/crds/cstorvolumereplica.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions deploy/helm/charts/crds/volumesnapshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
Expand Down Expand Up @@ -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.'
Expand Down Expand Up @@ -223,4 +223,4 @@ status:
conditions: []
storedVersions: []

---
---
2 changes: 1 addition & 1 deletion deploy/helm/charts/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down
22 changes: 11 additions & 11 deletions docs/api-references/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -1663,7 +1663,7 @@ uint64
</td>
<td>
<p>LogicalReferenced describes the amount of space that is &ldquo;logically&rdquo;
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.</p>
Expand Down Expand Up @@ -2078,7 +2078,7 @@ Kubernetes core/v1.ResourceList
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorVolumePolicy">CStorVolumePolicy</a>,
<a href="#cstor.openebs.io/v1.CStorVolumePolicy">CStorVolumePolicy</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeConfigSpec">CStorVolumeConfigSpec</a>)
</p>
<p>
Expand Down Expand Up @@ -2226,7 +2226,7 @@ include space consumed by metadata</p>
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorVolumeSpec">CStorVolumeSpec</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeSpec">CStorVolumeSpec</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeStatus">CStorVolumeStatus</a>)
</p>
<p>
Expand Down Expand Up @@ -2810,7 +2810,7 @@ It may contain several volumes</p>
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorPoolInstanceSpec">CStorPoolInstanceSpec</a>,
<a href="#cstor.openebs.io/v1.CStorPoolInstanceSpec">CStorPoolInstanceSpec</a>,
<a href="#cstor.openebs.io/v1.PoolSpec">PoolSpec</a>)
</p>
<p>
Expand Down Expand Up @@ -3073,7 +3073,7 @@ Any power of 2 from 512 bytes to 128 Kbytes is valid.</p>
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorPoolInstanceSpec">CStorPoolInstanceSpec</a>,
<a href="#cstor.openebs.io/v1.CStorPoolInstanceSpec">CStorPoolInstanceSpec</a>,
<a href="#cstor.openebs.io/v1.PoolSpec">PoolSpec</a>)
</p>
<p>
Expand Down Expand Up @@ -3181,7 +3181,7 @@ string
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorVolumeStatus">CStorVolumeStatus</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeStatus">CStorVolumeStatus</a>,
<a href="#cstor.openebs.io/v1.CVStatus">CVStatus</a>)
</p>
<p>
Expand Down Expand Up @@ -3280,7 +3280,7 @@ string
</em>
</td>
<td>
<p>Quorum indicates wheather data wrtitten to the replica
<p>Quorum indicates whether data wrtitten to the replica
is lost or exists.
&ldquo;0&rdquo; means: data has been lost( might be ephimeral case)
and will recostruct data from other Healthy replicas in a write-only
Expand Down Expand Up @@ -3438,10 +3438,10 @@ If left empty, no priority class is applied.</p>
</h3>
<p>
(<em>Appears on:</em>
<a href="#cstor.openebs.io/v1.CStorPoolCluster">CStorPoolCluster</a>,
<a href="#cstor.openebs.io/v1.CStorPoolInstance">CStorPoolInstance</a>,
<a href="#cstor.openebs.io/v1.CStorVolume">CStorVolume</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeConfig">CStorVolumeConfig</a>,
<a href="#cstor.openebs.io/v1.CStorPoolCluster">CStorPoolCluster</a>,
<a href="#cstor.openebs.io/v1.CStorPoolInstance">CStorPoolInstance</a>,
<a href="#cstor.openebs.io/v1.CStorVolume">CStorVolume</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeConfig">CStorVolumeConfig</a>,
<a href="#cstor.openebs.io/v1.CStorVolumeReplica">CStorVolumeReplica</a>)
</p>
<p>
Expand Down

0 comments on commit 32c4ac8

Please sign in to comment.