Apply suggestions from code review

Co-authored-by: Grzegorz Karaluch <[email protected]>
kyma-project · Apr 9, 2024 · f0b7032 · f0b7032
1 parent a97f084
commit f0b7032
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/lat
 
 > **NOTE:** To clean up the k3d cluster, use the `make delete-k3d` make target.
 
-> **NOTE:** If you have k3d already running you can use `install-*` target to install serverless in different flavours.
+> **NOTE:** If you have k3d already running you can use `install-*` target to install Serverless in different flavors.
 
 ## Using Serverless Operator
 

diff --git a/components/operator/README.md b/components/operator/README.md
@@ -10,33 +10,32 @@ The Function Operator requires the following components to be installed:
 
 ## Development
 
-### Installing locally build serverless operator image on k3d with serverless
+### Installing Locally Built Serverless Operator Image on k3d With Serverless
 Prerequisite:
-- installed operator on cluster
+- installed Operator on a cluster
 
-To install serverless-manager from local sources on k3d cluster run:
+To install `serverless-manager` from local sources on the k3d cluster run:
 
 ```bash
 make install-operator-k3d
 ```
 
+This target:
 
-This target does:
+- builds local image with `serverless-operator`
+- tags local the `serverless-operator` image with its hash to be sure the deployment is updated
+- uploads local image to k3d
+- updates the image in the `serverless-operator` deployment
 
-- build local image with serverless-operator
-- tag local serverless-operator image with its hash to be sure to deployment be updated
-- upload local image to k3d
-- update image in serverless-operator deployment
+### Running/Debugging `serverless-operator` Locally
 
-### Running/Debugging serverless-operator locally
-
-To develop the component as normal binary, set up environment variables.
+To develop the component as a normal binary, set up environment variables.
 
 ### Environment Variables
 
 #### The Function Operator Uses These Environment Variables:
 
 | Variable                   | Description                                                                                                         | Default value   |
 |----------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------|
-| **CHART_PATH**             | Location of serverless chart                                                                                        | `/module-chart` |
-| **SERVERLESS_MANAGER_UID** | Unique ID of operator instance. Used to mark created resources to distinguish which version of operator created it. | ``              |
+| **CHART_PATH**             | Location of the Serverless chart                                                                                        | `/module-chart` |
+| **SERVERLESS_MANAGER_UID** | Unique ID of operator instance. Used to mark created resources to distinguish which version of the Operator created it. | ``              |
diff --git a/components/serverless/README.md b/components/serverless/README.md
@@ -14,23 +14,23 @@ To develop the Function Controller, you need:
 - [controller-gen](https://github.com/kubernetes-sigs/controller-tools/releases/tag/v0.6.2) (v0.6.2)
 - <!-- markdown-link-check-disable-line -->[kustomize](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.5.7) (v4.5.7)
 
-### Installing locally build serverless controller image on k3d with serverless
+### Installing Locally Built Serverless Controller Image on k3d With Serverless
 Prerequisite:
-- installed serverless on cluster
+- installed Serverless on a cluster
 
-To install serverless-controller from local sources on k3d cluster run:
+To install `serverless-controller` from local sources on the k3d cluster run:
 ```bash
 make install-controller-k3d
 ```
 
-This target does:
-- scale down serverless operator to prevent reverting further changes made to serverless-controller deployment
-- build local image with serverless-controller image
-- tag local serverless-controller image with its hash to be sure to deployment be updated
-- upload local image to k3d
-- update image in serverless-ctrl-mngr deployment
+This target:
+- scales down the Serverless Operator to prevent reverting further changes made to the `serverless-controller` deployment
+- builds the local image with the `serverless-controller` image
+- tags the local `serverless-controller` image with its hash to be sure the deployment is updated
+- uploads the local image to k3d
+- updates the image in the `serverless-ctrl-mngr` deployment
 
-### Running/Debugging serverless-manager locally
+### Running/Debugging serverless-manager Locally
 To develop the component as normal binary, set up envs correctly, example envs to use [controller.env](./hack/controller.env).
 You can customize the configuration by editing files in [hack](./hack) dir.