Skip to content

Commit

Permalink
fix: markdown linter warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Oleksii Kurinnyi <[email protected]>
  • Loading branch information
akurinnoy committed Jan 23, 2025
1 parent f2164c9 commit 4b65628
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 18 deletions.
11 changes: 7 additions & 4 deletions docs/installation/kind-without-olm-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

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

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

## Steps

Expand Down Expand Up @@ -108,6 +108,7 @@ Get the internal IP address of your Kind control-plane node:
```sh
kubectl get node -o wide
```

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.

#### 6.2 Create the DevWorkspaceOperatorConfig
Expand Down Expand Up @@ -176,14 +177,16 @@ EOF
```bash
kubectl patch devworkspace git-clone-sample-devworkspace -n default --type merge -p '{"spec": {"started": true}}'
```

You can also check the DevWorkspace status by running:

```sh
kubectl get devworkspace -n default
```

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:

```
```sh
NAME DEVWORKSPACE ID PHASE INFO
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
```
12 changes: 8 additions & 4 deletions docs/installation/kind-without-olm-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

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

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

## Steps

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

#### 8.1 Get Load Balancer IP

Get the Load Balancer IP from the `ingress-nginx` service:

```sh
Expand All @@ -146,6 +147,7 @@ kubectl get services \
ingress-nginx-controller \
--output jsonpath='{.status.loadBalancer.ingress[0].ip}'
```

Let's denote this value as `<HOST_IP>`.

#### 8.2 Create the DevWorkspaceOperatorConfig
Expand Down Expand Up @@ -214,14 +216,16 @@ EOF
```bash
kubectl patch devworkspace git-clone-sample-devworkspace -n default --type merge -p '{"spec": {"started": true}}'
```

You can also check the DevWorkspace status by running:

```sh
kubectl get devworkspace -n default
```

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:

```
```sh
NAME DEVWORKSPACE ID PHASE INFO
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
```
6 changes: 3 additions & 3 deletions docs/installation/minikube-without-olm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

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

* **kubectl:** The Kubernetes command-line tool.
* **minikube:** A tool for running Kubernetes locally.
* **kubectl:** The Kubernetes command-line tool.
* **minikube:** A tool for running Kubernetes locally.

## Steps

Expand Down Expand Up @@ -152,7 +152,7 @@ kubectl get devworkspace -n default

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:

```
```sh
NAME DEVWORKSPACE ID PHASE INFO
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
```
7 changes: 4 additions & 3 deletions docs/installation/openshift-with-olm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

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

* **oc:** The OpenShift command-line tool.
* Access to an OpenShift cluster.
* **oc:** The OpenShift command-line tool.
* Access to an OpenShift cluster.

## Steps

Expand Down Expand Up @@ -122,13 +122,14 @@ oc patch devworkspace git-clone-sample-devworkspace -n devworkspace-samples --ty
```

You can also check the DevWorkspace status by running:

```sh
oc get devworkspace -n devworkspace-samples
```

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:

```
```sh
NAME DEVWORKSPACE ID PHASE INFO
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
```
9 changes: 5 additions & 4 deletions docs/installation/openshift-without-olm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

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

* **oc:** The OpenShift command-line tool.
* Access to an OpenShift cluster.
* **oc:** The OpenShift command-line tool.
* Access to an OpenShift cluster.

## Steps

Expand Down Expand Up @@ -42,7 +42,6 @@ Create a namespace for the DevWorkspace sample:
oc create namespace devworkspace-samples
```


### 4. Create a Sample DevWorkspace

Create a sample DevWorkspace in the `devworkspace-samples` namespace:
Expand Down Expand Up @@ -93,14 +92,16 @@ EOF
```sh
oc patch devworkspace git-clone-sample-devworkspace -n devworkspace-samples --type merge -p '{"spec": {"started": true}}'
```

You can also check the DevWorkspace status by running:

```sh
oc get devworkspace -n devworkspace-samples
```

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:

```
```sh
NAME DEVWORKSPACE ID PHASE INFO
git-clone-sample-devworkspace workspace0196ce197f0b4e90 Running <URL>
```

0 comments on commit 4b65628

Please sign in to comment.