From 1dc9e448c6fb2a19076b7ebc6d0bed84e4858857 Mon Sep 17 00:00:00 2001
From: Artem Kladov <6360800+z9r5@users.noreply.github.com>
Date: Mon, 22 Jan 2024 18:44:11 +0300
Subject: [PATCH] Apply suggestions from code review

Co-authored-by: Kirill Kononovich <41591254+kirkonru@users.noreply.github.com>
Signed-off-by: Artem Kladov <6360800+z9r5@users.noreply.github.com>
---
 crds/blockdevices.yaml   | 6 +++---
 crds/lvmvolumegroup.yaml | 6 +++---
 docs/CONFIGURATION.md    | 2 +-
 docs/CR.md               | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/crds/blockdevices.yaml b/crds/blockdevices.yaml
index 6a10e655..e919b8d8 100644
--- a/crds/blockdevices.yaml
+++ b/crds/blockdevices.yaml
@@ -24,7 +24,7 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            The resource displays actual information about block devices, which might be used by the sds-node-configurator controller for operations in LVM.
+            The resource displays up-to-date information about available block devices on nodes that can be used by the sds-node-configurator controller for LVM operations.
             
             > The resource is created and managed by the controller only. Manual modification of the resource is prohibited.
           properties:
@@ -58,7 +58,7 @@ spec:
                 vgUUID:
                   type: string
                   description: | 
-                    The UUID of the LVM Volume Group to which this device belongs as a Physical Volume.
+                    The UUID of the LVM Volume Group to which this device belongs to as a Physical Volume.
 
                     > Optional: exists only if the device is used as a Physical Volume and is included in a Volume Group.
                 lvmVolumeGroupName:
@@ -66,7 +66,7 @@ spec:
                   description: | 
                     The LVMVolumeGroup resource name. 
                     
-                    > Optional: exists only if the device is used as a Physical Volume, included in a Volume Group, and specified in an LVMVolumeGroup resource.
+                    > Optional: exists only if the device is used as a Physical Volume, is included in a Volume Group, and is specified in an LVMVolumeGroup resource.
                 actualVGNameOnTheNode:
                   type: string
                   description: |
diff --git a/crds/lvmvolumegroup.yaml b/crds/lvmvolumegroup.yaml
index c7fe00f2..7f19a599 100644
--- a/crds/lvmvolumegroup.yaml
+++ b/crds/lvmvolumegroup.yaml
@@ -26,7 +26,7 @@ spec:
           description: |
             An interface for managing Volume Groups and Thin pools on the nodes.
             
-            > These resources might be created both by a user and the sds-node-configurator controller. The sds-node-configurator controller will automatically create an LVMVolumeGroup resource if it detects an existing Volume Group on a node tagged with 'storage.deckhouse.io/enabled=true'. The controller will fill both the 'Spec' and 'Status' fields.
+            > These resources might be created both by a user and the sds-node-configurator controller. The sds-node-configurator controller will automatically create an LVMVolumeGroup resource if it detects an existing Volume Group on a node tagged with 'storage.deckhouse.io/enabled=true'. The controller will fill in both the 'spec' and 'status' fields.
           required:
             - spec
           properties:
@@ -37,7 +37,7 @@ spec:
                   type: string
                   description: |
                     The type of a Volume Group. Might be:
-                    - Local, meaning local if the used devices are not distributed (not Shared LUN).
+                    - Local, that is, local if the devices used are not distributed (not Shared LUN).
                   enum:
                     - Local
                 blockDeviceNames:
@@ -102,7 +102,7 @@ spec:
                 allocatedSize:
                   type: string
                   description: |
-                    The current space occupied on the Volume Group.
+                    The amount of space currently occupied on the Volume Group.
                 thinPools:
                   type: array
                   description: |
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
index 3f65b3ef..465b78c1 100644
--- a/docs/CONFIGURATION.md
+++ b/docs/CONFIGURATION.md
@@ -6,5 +6,5 @@ description: "Settings of the sds-node-configurator module. Deckhouse Kubernetes
 {{< alert level="warning" >}}
 The module is guaranteed to work only with stock kernels that are shipped with the [supported distributions](https://deckhouse.io/documentation/v1/supported_versions.html#linux).
 
-The functionality of the module with other kernels or distributions is possible but not guaranteed.
+The module may work with other kernels or distributions, but its stable operation and availability of all features is not guaranteed.
 {{< /alert >}}
diff --git a/docs/CR.md b/docs/CR.md
index 26453ebd..6d27a7ba 100644
--- a/docs/CR.md
+++ b/docs/CR.md
@@ -6,5 +6,5 @@ description: "BlockDevice and LVMVolumeGroup custom resources. The sds-node-conf
 {{< alert level="warning" >}}
 The module is guaranteed to work only with stock kernels that are shipped with the [supported distributions](https://deckhouse.io/documentation/v1/supported_versions.html#linux).
 
-The functionality of the module with other kernels or distributions is possible but not guaranteed.
+The module may work with other kernels or distributions, but its stable operation and availability of all features is not guaranteed.
 {{< /alert >}}