Corrections in the documentation Chapter One required. #sodacode2022 #sodalow

[Tenison]

Hi, Read through the docs chapter one and found some corrections. I would like to point them out.

• should be help in place of serve @ Intro

- This guide is intended to __serve__ users of the software-defined storage (SDS) solution LINSTOR® as a definitive reference guide and handbook.
+ This guide is intended to help users of the software-defined storage (SDS) solution LINSTOR® as a definitive reference guide and handbook.

• should be into in place of in Basic administrative tasks / Setup

- Basic administrative tasks / Setup deals with LINSTOR’s basic functionality and gives you an insight __in__ using common administrative tasks
+ Basic administrative tasks / Setup deals with LINSTOR’s basic functionality and gives you an insight into using common administrative tasks

• should be from that, in place of of that @ Basic administrative tasks / Setup

- Apart __of that__ you can use this chapter as a step-by-step instruction guide to deploy LINSTOR in its basic setup.
+ Apart from that, you can use this chapter as a step-by-step instruction guide to deploy LINSTOR in its basic setup.

• Add , to tasks @ Further LINSTOR tasks section

- In Further LINSTOR __tasks__ a variety of advanced and important LINSTOR tasks as well as configurations ...
+ In Further LINSTOR tasks, a variety of advanced and important LINSTOR tasks as well as configurations

• should be are servers or containers instead of are a server or container @ Nodes

- Nodes __are a server or container__ that participate in a LINSTOR cluster.
+ Nodes are servers or containers that participate in a LINSTOR cluster.

• should be profiles or templates in place of profile or template @ Definitions

- Definitions define attributes of an object, they can be thought of as __profile or template__ 
+ Definitions define attributes of an object, they can be thought of as profiles or templates

• Replace prior to with before @ Definitions. Makes this section easy to understand

- A definition must be defined __prior to__ creating the associated object 
+  A definition must be defined before creating the associated object

- For example; you must create a ResourceDefinition __prior to__ creating the Resource 
+ For example; you must create a ResourceDefinition before creating the Resource

• Add , to for example @ Volume

- ... for __example__ you may wish to have your database stored on slower storage than your logs in your MySQL cluster
+  ... for example, you may wish to have your database stored on slower storage than your logs in your MySQL cluster

• Sentence should change @ Line 5: 1.4.2. SUSE Linux Enterprise Server

- __User who prefer a command line install may simply issue the following command to get the newest DRBD and LVM version:__
+ Users who prefer command-line install may simply issue the following command to get the newest DRBD and LVM versions:

• should be 3rd party in place of 3rd parties @ caution sign : 1.4.3. CentOS

- This requires an external repository to be configured, either LINBIT’s or a __3rd parties.__ 
+ This requires an external repository to be configured, either LINBIT’s or a 3rd party.

• should be manual in place of manually @ Paragraph 3 or Line 10 : 1.5. Upgrading

- ... it is recommended to do a __manually__ backup of your current database to have a restore point.
+ ... it is recommended to do a manual backup of your current database to have a restore point.

• should be your in place of you @ Paragraph 4 or Line 12 : 1.5. Upgrading

- ...  linstor-client package on __you__ controller host and restart the linstor-controller, 
+ ...  linstor-client package on your controller host and restart the linstor-controller, 

• should be up-to-date in place of up to date @ Paragraph 3 : 1.6. Containers

- An __up to date__ list of available images with versions can be retrieved by opening http://drbd.io/ ...
+ An up-to-date list of available images with versions can be retrieved by opening http://drbd.io/ ...

• should be command-line in place of command line @ 1.8. Using the LINSTOR client

- Whenever you run the LINSTOR __command line__ client ...
+ Whenever you run the LINSTOR command-line client ...

- As shown, this can be specified as a __command line__ option, ...
+ As shown, this can be specified as a command-line option, ...

• Add , to Alternatively @ Paragraph 3 : 1.8. Using the LINSTOR client

- ... __Alternatively__ you can create the /etc/linstor/linstor-client.conf file and populate it like below.
+ ... Alternatively, you can create the /etc/linstor/linstor-client.conf file and populate it like below.

• should be parameter in place of parameter , @ Paragraph 2 Line 2 : 1.13. Creating and deploying resources/volumes

- You have to provide this __parameter ,__ because resources can have multiple ...
+ You have to provide this parameter because resources can have multiple ...

• should be that, in place of of that @ caution sign : 1.13. Creating and deploying resources/volumes

- Despite __of that__ the size can be increased even with a deployed resource.
+ Despite that, the size can be increased even with a deployed resource.

• should be just space instead of spaced @ Paragraph 3 bullet 2 : 1.13.2. Autoplace

- MinReservedSpace: Unlike the “MaxFreeSpace”, this strategy considers the reserved __spaced__.
+ MinReservedSpace: Unlike the “MaxFreeSpace”, this strategy considers the reserved space.

• should be pool's instead of pools @ Paragraph 3 bullet 2 Line 3 : 1.13.2. Autoplace

- The sum of reserved spaces might exceed the storage __pools__ capacity, which is as overprovisioning.
+ The sum of reserved spaces might exceed the storage pool's capacity, which is as overprovisioning.

• Add , to Finally@ Paragraph 5 : 1.13.2. Autoplace

- __Finally__ LINSTOR tries to find the best matching group of storage pools meeting all requirements.
+ Finally, LINSTOR tries to find the best matching group of storage pools meeting all requirements.

• should be auto-placement instead of autoplacement @ Paragraph 5 Line 2 : 1.13.2. Autoplace

- This step also considers other __autoplacement__ restrictions as --replicas-on-same, --replicas-on-different and others.
+ This step also considers other auto-placement restrictions as --replicas-on-same, --replicas-on-different and others.

• should be such as in place of as @ Paragraph 5 Line 2 : 1.13.2. Autoplace

- This step also considers other auto-placement restrictions __as__ --replicas-on-same, --replicas-on-different and others.
+ This step also considers other auto-placement restrictions such as --replicas-on-same, --replicas-on-different and others..

[Tenison]

Please add label SODACODELOW and SODACODE2022

[Tenison]

I would also like to work on this issue if it is accepted.

[anvithks]

@yusufyildiz PTAL

[Tenison]

Please can you help me point out some of the things I should be looking at?

@yusufyildiz PTAL

[yusufyildiz]

@anvithks @Tenison #SODACODE-issue-Accepted #sodacode2022 Thank you! awesome contribution.

[yusufyildiz]

@Tenison you can work on the issue if you like here: https://github.com/LINBIT/linbit-documentation/tree/master/UG9/en then we'll check and merge.

[Tenison]

Thanks a lot. I will revert if I need any assistance

[Tenison]

Raised a PR to fix this issue #37 @yusufyildiz

[yusufyildiz]

#SODACODE-PR-ACCEPTED

[rp-]

@yusufyildiz close?