Skip to content

Commit 52fb495

Browse files
committed
Implemented enhancements from doc review
According to documentation style guide and policies, fixed wording, style, grammar, punctuation.
1 parent 3e33512 commit 52fb495

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

adoc/SAP-EIC-Main.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,10 @@ include::SAP-Rancher-RKE2-Installation.adoc[tags=!install-rke2-harvester]
151151

152152
== Preparing storage
153153

154-
In order to make storage available for Kubernetes workloads, you'll need to prepare the storage solution you want to use.
155-
In this chapter we'll describe how to those up and how to prepare it, so {eic} can consume it.
154+
To make storage available for Kubernetes workloads, prepare the storage solution you want to use.
155+
In this chapter, we will describe how to set this up and how to prepare it for consumption by {eic}.
156156

157-
The tested storage solutions by SAP and SUSE are shown below with a link to the chapter, where we'll describe how to set them up and configure them:
157+
The storage solutions tested by SAP and SUSE are presented below, along with links to chapters detailing their setup and configuration.
158158

159159
* {lh} <<Longhorn>>
160160
* {netapp} {trid} <<NetApp>>
@@ -184,7 +184,7 @@ NOTE: Keep in mind that the descriptions and instructions below might differ fro
184184

185185
=== Logging in to {rac}
186186

187-
To access the {rac} you need to log in. You can do this using the console and Helm client.
187+
To access the {rac}, you need to log in. You can do this using the console and Helm client.
188188
The easiest way to do so is to use the built-in shell in {rancher}. To access it, navigate to your cluster and click *Kubectl Shell* as shown below:
189189

190190
image::EIC-Rancher-Kubectl-Button.png[title=Rancher Shell Access,scaledwidth=99%]
@@ -204,7 +204,7 @@ helm registry login dp.apps.rancher.io/charts -u <yourUser> -p <your-token>
204204

205205
=== Installing {metallb} on Kubernetes cluster
206206

207-
This chapter is intended to guide you through the installation and configuration of {metallb} on your Kubernetes cluster used for {eic}.
207+
The following chapter should guide you through the installation and configuration of {metallb} on your Kubernetes cluster used for {eic}.
208208

209209
include::SAP-EIC-Metallb.adoc[Metallb, leveloffset=2]
210210

adoc/SAP-EIC-Netapp.adoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ For more details how to install {trid} with Helm, visit https://docs.netapp.com/
1212
=== Preparing the OS
1313

1414
The Kubernetes worker nodes must be prepared so PVCs can later be provisioned properly.
15-
Thus you need to install the following packages:
15+
Thus, you need to install the following packages:
1616

1717
[source, bash, subs="attributes"]
1818
----
1919
sudo zypper in -y lsscsi multipath-tools open-iscsi
2020
----
2121

22-
As multipathd is known to have problems on OS using the kernel-default-base packages, replace them with kernel-default:
22+
As multipathd is known to have problems on OS using the kernel-default-base packages, replace them with `kernel-default`:
2323

2424
[source, bash, subs="attributes"]
2525
----
@@ -42,7 +42,7 @@ sudo systemctl enable --now multipathd
4242
=== Deploying the {trid} operator
4343

4444
The {trid} operator is responsible to establish the connection between your {netapp} storage system and the Kubernetes cluster.
45-
An example of how to deploy it looks like follows:
45+
An example of its deployment is shown below:
4646

4747
[source, bash, subs="attributes"]
4848
----
@@ -54,10 +54,10 @@ helm install my-trident-operator netapp-trident/trident-operator --version 100.2
5454

5555
# tag::backend-config[]
5656

57-
=== Establish the connection between Kubernetes and the {netapp} storage
57+
=== Establishing the connection between Kubernetes and the {netapp} storage
5858

59-
Before creating the link to the backend, it's recommended to store the user and password information in a Secret.
60-
To create such a secret you can use:
59+
Before creating the link to the backend, you should store the user and password information in a Secret.
60+
To create such a Secret, follow the example below:
6161

6262
[source, yaml]
6363
----
@@ -72,10 +72,10 @@ stringData:
7272
password: <password>
7373
----
7474

75-
To establish the connection between the target Kubernetes cluster and the {netapp} storage system, a so called *TridentBackendConfig* is required.
76-
To get more information how to set up the backend configuration, refer to https://docs.netapp.com/us-en/trident/trident-use/backend-kubectl.html#tridentbackendconfig
75+
To establish the connection between the target Kubernetes cluster and the {netapp} storage system, a so-called *TridentBackendConfig* is required.
76+
For more information how to set up the backend configuration, refer to https://docs.netapp.com/us-en/trident/trident-use/backend-kubectl.html#tridentbackendconfig
7777

78-
The following two examples are showing what the configuration for a SAN/iscsi backend and a NAS backend looks like:
78+
Below are two examples demonstrating the configuration of SAN/iSCSI and NAS backends:
7979

8080
[source, yaml]
8181
----
@@ -120,16 +120,17 @@ To verify the backend was configured successfully, check the output of:
120120
kubectl -n trident get tbc backend-tbc-ontap-san
121121
----
122122

123-
If the connection was established, the *State* should be active and you should see a *Backend UUID*
123+
If the connection was established, the *State* should be active and you should see a *Backend UUID*.
124124

125125
# end::backend-config[]
126126

127127
//TODO example picture
128128

129129
# tag::storageClass[]
130130

131-
Once the backend is configured, you can create a *StorageClass* to provision Volumes to be consumed by a Persistent Volume Claim.
132-
Here's an example that will create a storageClass that will use an SAN/iscsi backend:
131+
When the backend is configured, you can create a *StorageClass* to provision Volumes to be consumed by a Persistent Volume Claim.
132+
Here's an example for creating a StorageClass that uses a SAN/iSCSI backend:
133+
133134

134135
[source, yaml]
135136
----

0 commit comments

Comments
 (0)