Skip to content

Commit 5864a64

Browse files
akurinnoydkwon17
authored andcommitted
fix: markdown linter warnings
Signed-off-by: Oleksii Kurinnyi <[email protected]>
1 parent 281440d commit 5864a64

5 files changed

+27
-18
lines changed

docs/installation/kind-without-olm-linux.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Before you begin, ensure you have the following tools installed:
66

7-
* **kubectl:** The Kubernetes command-line tool.
8-
* **kind:** A tool for running Kubernetes locally using Docker.
9-
* **Docker** (as a container runtime)
7+
* **kubectl:** The Kubernetes command-line tool.
8+
* **kind:** A tool for running Kubernetes locally using Docker.
9+
* **Docker** (as a container runtime)
1010

1111
## Steps
1212

@@ -108,6 +108,7 @@ Get the internal IP address of your Kind control-plane node:
108108
```sh
109109
kubectl get node -o wide
110110
```
111+
111112
Look for the `INTERNAL-IP` of the `kind-control-plane` node. Let's denote this as `<HOST_IP>`. You will use this IP in the next step.
112113

113114
#### 6.2 Create the DevWorkspaceOperatorConfig
@@ -176,14 +177,16 @@ EOF
176177
```bash
177178
kubectl patch devworkspace git-clone-sample-devworkspace -n default --type merge -p '{"spec": {"started": true}}'
178179
```
180+
179181
You can also check the DevWorkspace status by running:
182+
180183
```sh
181184
kubectl get devworkspace -n default
182185
```
183186

184187
When the DevWorkspace is running according to the status, open the editor by accesssing the URL from the `INFO` column in a web browser. For example:
185188

186-
```
189+
```sh
187190
NAME DEVWORKSPACE ID PHASE INFO
188191
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
189192
```

docs/installation/kind-without-olm-macos.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Before you begin, ensure you have the following tools installed:
66

7-
* **kubectl:** The Kubernetes command-line tool.
8-
* **kind:** A tool for running Kubernetes locally using Docker.
9-
* **OrbStack** (as a container runtime)
7+
* **kubectl:** The Kubernetes command-line tool.
8+
* **kind:** A tool for running Kubernetes locally using Docker.
9+
* **OrbStack** (as a container runtime)
1010

1111
## Steps
1212

@@ -138,6 +138,7 @@ kubectl wait --namespace devworkspace-controller \
138138
### 8. Create the DevWorkspace Operator Config
139139

140140
#### 8.1 Get Load Balancer IP
141+
141142
Get the Load Balancer IP from the `ingress-nginx` service:
142143

143144
```sh
@@ -146,6 +147,7 @@ kubectl get services \
146147
ingress-nginx-controller \
147148
--output jsonpath='{.status.loadBalancer.ingress[0].ip}'
148149
```
150+
149151
Let's denote this value as `<HOST_IP>`.
150152

151153
#### 8.2 Create the DevWorkspaceOperatorConfig
@@ -214,14 +216,16 @@ EOF
214216
```bash
215217
kubectl patch devworkspace git-clone-sample-devworkspace -n default --type merge -p '{"spec": {"started": true}}'
216218
```
219+
217220
You can also check the DevWorkspace status by running:
221+
218222
```sh
219223
kubectl get devworkspace -n default
220224
```
221225

222226
When the DevWorkspace is running according to the status, open the editor by accesssing the URL from the `INFO` column in a web browser. For example:
223227

224-
```
228+
```sh
225229
NAME DEVWORKSPACE ID PHASE INFO
226230
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
227231
```

docs/installation/minikube-without-olm.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Before you begin, ensure you have the following tools installed:
66

7-
* **kubectl:** The Kubernetes command-line tool.
8-
* **minikube:** A tool for running Kubernetes locally.
7+
* **kubectl:** The Kubernetes command-line tool.
8+
* **minikube:** A tool for running Kubernetes locally.
99

1010
## Steps
1111

@@ -152,7 +152,7 @@ kubectl get devworkspace -n default
152152

153153
When the DevWorkspace is running according to the status, open the editor by accesssing the URL from the `INFO` column in a web browser. For example:
154154

155-
```
155+
```sh
156156
NAME DEVWORKSPACE ID PHASE INFO
157157
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
158158
```

docs/installation/openshift-with-olm.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Before you begin, ensure you have the following tools installed:
66

7-
* **oc:** The OpenShift command-line tool.
8-
* Access to an OpenShift cluster.
7+
* **oc:** The OpenShift command-line tool.
8+
* Access to an OpenShift cluster.
99

1010
## Steps
1111

@@ -122,13 +122,14 @@ oc patch devworkspace git-clone-sample-devworkspace -n devworkspace-samples --ty
122122
```
123123

124124
You can also check the DevWorkspace status by running:
125+
125126
```sh
126127
oc get devworkspace -n devworkspace-samples
127128
```
128129

129130
When the DevWorkspace is running according to the status, open the editor by accesssing the URL from the `INFO` column in a web browser. For example:
130131

131-
```
132+
```sh
132133
NAME DEVWORKSPACE ID PHASE INFO
133134
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
134135
```

docs/installation/openshift-without-olm.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Before you begin, ensure you have the following tools installed:
66

7-
* **oc:** The OpenShift command-line tool.
8-
* Access to an OpenShift cluster.
7+
* **oc:** The OpenShift command-line tool.
8+
* Access to an OpenShift cluster.
99

1010
## Steps
1111

@@ -42,7 +42,6 @@ Create a namespace for the DevWorkspace sample:
4242
oc create namespace devworkspace-samples
4343
```
4444

45-
4645
### 4. Create a Sample DevWorkspace
4746

4847
Create a sample DevWorkspace in the `devworkspace-samples` namespace:
@@ -93,14 +92,16 @@ EOF
9392
```sh
9493
oc patch devworkspace git-clone-sample-devworkspace -n devworkspace-samples --type merge -p '{"spec": {"started": true}}'
9594
```
95+
9696
You can also check the DevWorkspace status by running:
97+
9798
```sh
9899
oc get devworkspace -n devworkspace-samples
99100
```
100101

101102
When the DevWorkspace is running according to the status, open the editor by accesssing the URL from the `INFO` column in a web browser. For example:
102103

103-
```
104+
```sh
104105
NAME DEVWORKSPACE ID PHASE INFO
105106
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
106107
```

0 commit comments

Comments
 (0)