From 4b65628a232d1827e279dbb996cf485ceffdb2d1 Mon Sep 17 00:00:00 2001 From: Oleksii Kurinnyi Date: Thu, 23 Jan 2025 10:55:18 +0200 Subject: [PATCH] fix: markdown linter warnings Signed-off-by: Oleksii Kurinnyi --- docs/installation/kind-without-olm-linux.md | 11 +++++++---- docs/installation/kind-without-olm-macos.md | 12 ++++++++---- docs/installation/minikube-without-olm.md | 6 +++--- docs/installation/openshift-with-olm.md | 7 ++++--- docs/installation/openshift-without-olm.md | 9 +++++---- 5 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/installation/kind-without-olm-linux.md b/docs/installation/kind-without-olm-linux.md index 4d9ca5c3c..ca6a976f9 100644 --- a/docs/installation/kind-without-olm-linux.md +++ b/docs/installation/kind-without-olm-linux.md @@ -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 @@ -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 ``. You will use this IP in the next step. #### 6.2 Create the DevWorkspaceOperatorConfig @@ -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 ``` diff --git a/docs/installation/kind-without-olm-macos.md b/docs/installation/kind-without-olm-macos.md index 254c99075..d430b72c3 100644 --- a/docs/installation/kind-without-olm-macos.md +++ b/docs/installation/kind-without-olm-macos.md @@ -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 @@ -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 @@ -146,6 +147,7 @@ kubectl get services \ ingress-nginx-controller \ --output jsonpath='{.status.loadBalancer.ingress[0].ip}' ``` + Let's denote this value as ``. #### 8.2 Create the DevWorkspaceOperatorConfig @@ -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 ``` diff --git a/docs/installation/minikube-without-olm.md b/docs/installation/minikube-without-olm.md index a34eceadf..1745ae38c 100644 --- a/docs/installation/minikube-without-olm.md +++ b/docs/installation/minikube-without-olm.md @@ -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 @@ -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 ``` diff --git a/docs/installation/openshift-with-olm.md b/docs/installation/openshift-with-olm.md index 569889f9b..ef1ebf967 100644 --- a/docs/installation/openshift-with-olm.md +++ b/docs/installation/openshift-with-olm.md @@ -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 @@ -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 ``` diff --git a/docs/installation/openshift-without-olm.md b/docs/installation/openshift-without-olm.md index 7bca9eecd..7f5da8df9 100644 --- a/docs/installation/openshift-without-olm.md +++ b/docs/installation/openshift-without-olm.md @@ -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 @@ -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: @@ -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 ```