docs: fix spelling in docs and examples (#286)

numaproj · Oct 30, 2022 · fda3031 · fda3031
1 parent 88cf272
commit fda3031
Show file tree

Hide file tree

Showing 29 changed files with 448 additions and 449 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -17273,7 +17273,7 @@
         },
         "limits": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits",
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, will override pipeline level settings"
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings"
         },
         "metadata": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Metadata",
@@ -17467,7 +17467,7 @@
           "type": "integer"
         },
         "bufferUsageLimit": {
-          "description": "BufferUsageLimit is used to define the pencentage of the buffer usage limit, a valid value should be less than 100, for example, 85. It overrides the settings from pipeline limits.",
+          "description": "BufferUsageLimit is used to define the percentage of the buffer usage limit, a valid value should be less than 100, for example, 85. It overrides the settings from pipeline limits.",
           "format": "int64",
           "type": "integer"
         }
@@ -17884,7 +17884,7 @@
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.JetStreamBufferService"
         },
         "redis": {
-          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RedisBuferService"
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RedisBufferService"
         }
       },
       "type": "object"
@@ -18273,7 +18273,7 @@
           "type": "integer"
         },
         "bufferUsageLimit": {
-          "description": "BufferUsageLimit is used to define the pencentage of the buffer usage limit, a valid value should be less than 100, for example, 85. Only applies to UDF and Source vertice as only they do buffer write. It will be overridden by the settings in vertex limits.",
+          "description": "BufferUsageLimit is used to define the percentage of the buffer usage limit, a valid value should be less than 100, for example, 85. Only applies to UDF and Source vertice as only they do buffer write. It will be overridden by the settings in vertex limits.",
           "format": "int64",
           "type": "integer"
         },
@@ -18332,7 +18332,7 @@
         },
         "limits": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.PipelineLimits",
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, they could be overridden by each vertex's settings"
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, they could be overridden by each vertex's settings"
         },
         "vertices": {
           "items": {
@@ -18388,7 +18388,7 @@
       },
       "type": "object"
     },
-    "io.numaproj.numaflow.v1alpha1.RedisBuferService": {
+    "io.numaproj.numaflow.v1alpha1.RedisBufferService": {
       "properties": {
         "external": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RedisConfig",
@@ -18478,12 +18478,12 @@
           "type": "integer"
         },
         "replicasPerScale": {
-          "description": "ReplicasPerScale defines maximum replicas can be scaled up or down at once. The is use to prevent too aggresive scaling operations",
+          "description": "ReplicasPerScale defines maximum replicas can be scaled up or down at once. The is use to prevent too aggressive scaling operations",
           "format": "int64",
           "type": "integer"
         },
         "targetBufferUsage": {
-          "description": "TargetBufferUsage is used to define the target pencentage of usage of the buffer to be read. A valid and meaningful value should be less than the BufferUsageLimit defined in the Edge spec (or Pipeline spec), for example, 50. It only applies to UDF and Sink vertices as only they have buffers to read.",
+          "description": "TargetBufferUsage is used to define the target percentage of usage of the buffer to be read. A valid and meaningful value should be less than the BufferUsageLimit defined in the Edge spec (or Pipeline spec), for example, 50. It only applies to UDF and Sink vertices as only they have buffers to read.",
           "format": "int64",
           "type": "integer"
         },
@@ -18706,7 +18706,7 @@
         },
         "limits": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits",
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, will override pipeline level settings"
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings"
         },
         "metadata": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Metadata",

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -17280,7 +17280,7 @@
           "x-kubernetes-patch-strategy": "merge"
         },
         "limits": {
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, will override pipeline level settings",
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits"
         },
         "metadata": {
@@ -17472,7 +17472,7 @@
           "format": "int64"
         },
         "bufferUsageLimit": {
-          "description": "BufferUsageLimit is used to define the pencentage of the buffer usage limit, a valid value should be less than 100, for example, 85. It overrides the settings from pipeline limits.",
+          "description": "BufferUsageLimit is used to define the percentage of the buffer usage limit, a valid value should be less than 100, for example, 85. It overrides the settings from pipeline limits.",
           "type": "integer",
           "format": "int64"
         }
@@ -17880,7 +17880,7 @@
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.JetStreamBufferService"
         },
         "redis": {
-          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RedisBuferService"
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.RedisBufferService"
         }
       }
     },
@@ -18260,7 +18260,7 @@
           "format": "int64"
         },
         "bufferUsageLimit": {
-          "description": "BufferUsageLimit is used to define the pencentage of the buffer usage limit, a valid value should be less than 100, for example, 85. Only applies to UDF and Source vertice as only they do buffer write. It will be overridden by the settings in vertex limits.",
+          "description": "BufferUsageLimit is used to define the percentage of the buffer usage limit, a valid value should be less than 100, for example, 85. Only applies to UDF and Source vertice as only they do buffer write. It will be overridden by the settings in vertex limits.",
           "type": "integer",
           "format": "int64"
         },
@@ -18318,7 +18318,7 @@
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Lifecycle"
         },
         "limits": {
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, they could be overridden by each vertex's settings",
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, they could be overridden by each vertex's settings",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.PipelineLimits"
         },
         "vertices": {
@@ -18374,7 +18374,7 @@
         }
       }
     },
-    "io.numaproj.numaflow.v1alpha1.RedisBuferService": {
+    "io.numaproj.numaflow.v1alpha1.RedisBufferService": {
       "type": "object",
       "properties": {
         "external": {
@@ -18465,12 +18465,12 @@
           "format": "int32"
         },
         "replicasPerScale": {
-          "description": "ReplicasPerScale defines maximum replicas can be scaled up or down at once. The is use to prevent too aggresive scaling operations",
+          "description": "ReplicasPerScale defines maximum replicas can be scaled up or down at once. The is use to prevent too aggressive scaling operations",
           "type": "integer",
           "format": "int64"
         },
         "targetBufferUsage": {
-          "description": "TargetBufferUsage is used to define the target pencentage of usage of the buffer to be read. A valid and meaningful value should be less than the BufferUsageLimit defined in the Edge spec (or Pipeline spec), for example, 50. It only applies to UDF and Sink vertices as only they have buffers to read.",
+          "description": "TargetBufferUsage is used to define the target percentage of usage of the buffer to be read. A valid and meaningful value should be less than the BufferUsageLimit defined in the Edge spec (or Pipeline spec), for example, 50. It only applies to UDF and Sink vertices as only they have buffers to read.",
           "type": "integer",
           "format": "int64"
         },
@@ -18687,7 +18687,7 @@
           "type": "string"
         },
         "limits": {
-          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipleine, will override pipeline level settings",
+          "description": "Limits define the limitations such as buffer read batch size for all the vertices of a pipeline, will override pipeline level settings",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexLimits"
         },
         "metadata": {

diff --git a/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml b/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
@@ -87,7 +87,7 @@ spec:
                           format: int64
                           type: integer
                         bufferUsageLimit:
-                          description: BufferUsageLimit is used to define the pencentage
+                          description: BufferUsageLimit is used to define the percentage
                             of the buffer usage limit, a valid value should be less
                             than 100, for example, 85. It overrides the settings from
                             pipeline limits.
@@ -142,7 +142,7 @@ spec:
                   bufferUsageLimit: 80
                   readBatchSize: 500
                 description: Limits define the limitations such as buffer read batch
-                  size for all the vertices of a pipleine, they could be overridden
+                  size for all the vertices of a pipeline, they could be overridden
                   by each vertex's settings
                 properties:
                   bufferMaxLength:
@@ -155,7 +155,7 @@ spec:
                     type: integer
                   bufferUsageLimit:
                     default: 80
-                    description: BufferUsageLimit is used to define the pencentage
+                    description: BufferUsageLimit is used to define the percentage
                       of the buffer usage limit, a valid value should be less than
                       100, for example, 85. Only applies to UDF and Source vertice
                       as only they do buffer write. It will be overridden by the settings
@@ -1404,7 +1404,7 @@ spec:
                       type: array
                     limits:
                       description: Limits define the limitations such as buffer read
-                        batch size for all the vertices of a pipleine, will override
+                        batch size for all the vertices of a pipeline, will override
                         pipeline level settings
                       properties:
                         readBatchSize:
@@ -1487,12 +1487,12 @@ spec:
                         replicasPerScale:
                           description: ReplicasPerScale defines maximum replicas can
                             be scaled up or down at once. The is use to prevent too
-                            aggresive scaling operations
+                            aggressive scaling operations
                           format: int32
                           type: integer
                         targetBufferUsage:
                           description: TargetBufferUsage is used to define the target
-                            pencentage of usage of the buffer to be read. A valid
+                            percentage of usage of the buffer to be read. A valid
                             and meaningful value should be less than the BufferUsageLimit
                             defined in the Edge spec (or Pipeline spec), for example,
                             50. It only applies to UDF and Sink vertices as only they

diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -1217,7 +1217,7 @@ spec:
                           format: int64
                           type: integer
                         bufferUsageLimit:
-                          description: BufferUsageLimit is used to define the pencentage
+                          description: BufferUsageLimit is used to define the percentage
                             of the buffer usage limit, a valid value should be less
                             than 100, for example, 85. It overrides the settings from
                             pipeline limits.
@@ -1259,7 +1259,7 @@ spec:
                 type: string
               limits:
                 description: Limits define the limitations such as buffer read batch
-                  size for all the vertices of a pipleine, will override pipeline
+                  size for all the vertices of a pipeline, will override pipeline
                   level settings
                 properties:
                   readBatchSize:
@@ -1343,12 +1343,12 @@ spec:
                     type: integer
                   replicasPerScale:
                     description: ReplicasPerScale defines maximum replicas can be
-                      scaled up or down at once. The is use to prevent too aggresive
+                      scaled up or down at once. The is use to prevent too aggressive
                       scaling operations
                     format: int32
                     type: integer
                   targetBufferUsage:
-                    description: TargetBufferUsage is used to define the target pencentage
+                    description: TargetBufferUsage is used to define the target percentage
                       of usage of the buffer to be read. A valid and meaningful value
                       should be less than the BufferUsageLimit defined in the Edge
                       spec (or Pipeline spec), for example, 50. It only applies to
@@ -1981,7 +1981,7 @@ spec:
                           format: int64
                           type: integer
                         bufferUsageLimit:
-                          description: BufferUsageLimit is used to define the pencentage
+                          description: BufferUsageLimit is used to define the percentage
                             of the buffer usage limit, a valid value should be less
                             than 100, for example, 85. It overrides the settings from
                             pipeline limits.