From bd08dc002c21c66dbcb88371ce45cf5ea34ea5e0 Mon Sep 17 00:00:00 2001
From: Jesse Claven <jesse.claven@me.com>
Date: Mon, 18 Sep 2023 18:21:46 +0100
Subject: [PATCH] fix(docs): Use consistent shell style (#5133)

I noticed the lack of spaces. There's also a fix where a closing
apostrophe was missing.

I've also improved some of the phrasing.
---
 docs/source/contents/cli/index.md             | 13 +++----
 .../examples/huggingface/huggingface.ipynb    |  4 +-
 samples/examples/huggingface/huggingface.md   |  4 +-
 samples/examples/image_classifier/infer.ipynb |  2 +-
 samples/examples/image_classifier/infer.md    |  2 +-
 .../examples/income_classifier/infer.ipynb    |  2 +-
 samples/examples/income_classifier/infer.md   |  2 +-
 .../income_classifier/infer_local.ipynb       |  2 +-
 .../examples/income_classifier/infer_local.md |  2 +-
 samples/pipeline-errors.ipynb                 |  2 +-
 samples/pipeline-errors.md                    |  2 +-
 samples/pipeline-examples.ipynb               |  4 +-
 samples/pipeline-examples.md                  |  4 +-
 samples/pipeline-tests.sh                     | 38 +++++++++----------
 samples/pipeline-to-pipeline.ipynb            | 14 +++----
 samples/pipeline-to-pipeline.md               | 14 +++----
 .../notebooks/pipeline-alibi-detect.ipynb     |  2 +-
 .../pipeline-batch-data-flow-example.ipynb    |  2 +-
 18 files changed, 57 insertions(+), 58 deletions(-)

diff --git a/docs/source/contents/cli/index.md b/docs/source/contents/cli/index.md
index 220245d3d7..0ab673aab2 100644
--- a/docs/source/contents/cli/index.md
+++ b/docs/source/contents/cli/index.md
@@ -34,13 +34,13 @@ These defaults will be correct when Seldon Core v2 is installed locally as per t
 
 ### Inference Service
 
-For a default install into the `seldon-mesh` namespace if you have exposed the inference svc as a loadbalancer you will find it at:
+For a default install into the `seldon-mesh` namespace if you have exposed the inference `svc` as a loadbalancer you will find it at:
 
 ```
 kubectl get svc seldon-mesh -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
 ```
 
-So use above ip at port 80:
+Use above IP at port 80:
 
 ```
 export SELDON_INFER_HOST=<ip>:80
@@ -51,18 +51,18 @@ export SELDON_INFER_HOST=<ip>:80
 For a default install into the `seldon-mesh` namespace if you have exposed the scheduler svc as a loadbalancer you will find it at:
 
 ```
-kubectl get svc seldon-scheduler -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}
+kubectl get svc seldon-scheduler -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
 ```
 
-So use above ip at port 9000:
+Use above IP at port 9004:
 
 ```
-export SELDON_SCHEDULE_HOST=<ip>:80
+export SELDON_SCHEDULE_HOST=<ip>:9004
 ```
 
 ### Kafka Broker
 
-The kafka broker will depend on how you have installed Kafka into your Kubernetes cluster. Find the broker IP and use
+The Kafka broker will depend on how you have installed Kafka into your Kubernetes cluster. Find the broker IP and use:
 
 ```
 export SELDON_KAFKA_BROKER=<ip>:<port>
@@ -183,4 +183,3 @@ docs/seldon_pipeline_unload.md
 docs/seldon_pipeline_inspect.md
 docs/seldon_server_status.md
 ```
-
diff --git a/samples/examples/huggingface/huggingface.ipynb b/samples/examples/huggingface/huggingface.ipynb
index d25a986acd..254ae3ba31 100644
--- a/samples/examples/huggingface/huggingface.ipynb
+++ b/samples/examples/huggingface/huggingface.ipynb
@@ -472,7 +472,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status sentiment-explain -w PipelineReady| jq -M ."
+    "!seldon pipeline status sentiment-explain -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -662,7 +662,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status speech-to-sentiment -w PipelineReady| jq -M ."
+    "!seldon pipeline status speech-to-sentiment -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/examples/huggingface/huggingface.md b/samples/examples/huggingface/huggingface.md
index 56ad383a60..298d2ab6b7 100644
--- a/samples/examples/huggingface/huggingface.md
+++ b/samples/examples/huggingface/huggingface.md
@@ -294,7 +294,7 @@ seldon pipeline load -f ../../pipelines/sentiment-explain.yaml
 ```
 
 ```bash
-seldon pipeline status sentiment-explain -w PipelineReady| jq -M .
+seldon pipeline status sentiment-explain -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -414,7 +414,7 @@ seldon pipeline load -f ../../pipelines/speech-to-sentiment.yaml
 ```
 
 ```bash
-seldon pipeline status speech-to-sentiment -w PipelineReady| jq -M .
+seldon pipeline status speech-to-sentiment -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/examples/image_classifier/infer.ipynb b/samples/examples/image_classifier/infer.ipynb
index 1d8d3ef07f..3307af0c13 100644
--- a/samples/examples/image_classifier/infer.ipynb
+++ b/samples/examples/image_classifier/infer.ipynb
@@ -366,7 +366,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status cifar10-production -w PipelineReady| jq -M ."
+    "!seldon pipeline status cifar10-production -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/examples/image_classifier/infer.md b/samples/examples/image_classifier/infer.md
index ba9f7e45ed..a5c634d7c2 100644
--- a/samples/examples/image_classifier/infer.md
+++ b/samples/examples/image_classifier/infer.md
@@ -211,7 +211,7 @@ seldon pipeline load -f ../../pipelines/cifar10.yaml
 ```
 
 ```bash
-seldon pipeline status cifar10-production -w PipelineReady| jq -M .
+seldon pipeline status cifar10-production -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/examples/income_classifier/infer.ipynb b/samples/examples/income_classifier/infer.ipynb
index 0c6b1e42a1..c7cfc7b57e 100644
--- a/samples/examples/income_classifier/infer.ipynb
+++ b/samples/examples/income_classifier/infer.ipynb
@@ -293,7 +293,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status income-production -w PipelineReady| jq -M ."
+    "!seldon pipeline status income-production -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/examples/income_classifier/infer.md b/samples/examples/income_classifier/infer.md
index d306556782..ea0b759e4d 100644
--- a/samples/examples/income_classifier/infer.md
+++ b/samples/examples/income_classifier/infer.md
@@ -154,7 +154,7 @@ seldon pipeline load -f ../../pipelines/income.yaml
 ```
 
 ```bash
-seldon pipeline status income-production -w PipelineReady| jq -M .
+seldon pipeline status income-production -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/examples/income_classifier/infer_local.ipynb b/samples/examples/income_classifier/infer_local.ipynb
index 92ff9a1713..9f53002402 100644
--- a/samples/examples/income_classifier/infer_local.ipynb
+++ b/samples/examples/income_classifier/infer_local.ipynb
@@ -240,7 +240,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status income-production -w PipelineReady| jq -M ."
+    "!seldon pipeline status income-production -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/examples/income_classifier/infer_local.md b/samples/examples/income_classifier/infer_local.md
index 43257f3515..4a4427ad70 100644
--- a/samples/examples/income_classifier/infer_local.md
+++ b/samples/examples/income_classifier/infer_local.md
@@ -108,7 +108,7 @@ seldon pipeline load -f ../../pipelines/income.yaml
 ```
 
 ```bash
-seldon pipeline status income-production -w PipelineReady| jq -M .
+seldon pipeline status income-production -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/pipeline-errors.ipynb b/samples/pipeline-errors.ipynb
index f2b5fa3f31..957102f251 100644
--- a/samples/pipeline-errors.ipynb
+++ b/samples/pipeline-errors.ipynb
@@ -189,7 +189,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimples -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimples -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/pipeline-errors.md b/samples/pipeline-errors.md
index 2820845676..4e260c26ca 100644
--- a/samples/pipeline-errors.md
+++ b/samples/pipeline-errors.md
@@ -83,7 +83,7 @@ seldon pipeline load -f ./pipelines/tfsimples.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimples -w PipelineReady| jq -M .
+seldon pipeline status tfsimples -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/pipeline-examples.ipynb b/samples/pipeline-examples.ipynb
index 9acd141e1e..47d770ebe1 100644
--- a/samples/pipeline-examples.ipynb
+++ b/samples/pipeline-examples.ipynb
@@ -208,7 +208,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimples -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimples -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -684,7 +684,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimples-input -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimples-input -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/pipeline-examples.md b/samples/pipeline-examples.md
index cc2c89017e..dfb0498015 100644
--- a/samples/pipeline-examples.md
+++ b/samples/pipeline-examples.md
@@ -93,7 +93,7 @@ seldon pipeline load -f ./pipelines/tfsimples.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimples -w PipelineReady| jq -M .
+seldon pipeline status tfsimples -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -452,7 +452,7 @@ seldon pipeline load -f ./pipelines/tfsimples-input.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimples-input -w PipelineReady| jq -M .
+seldon pipeline status tfsimples-input -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/samples/pipeline-tests.sh b/samples/pipeline-tests.sh
index 7706d89d5a..0bdc1f5f26 100755
--- a/samples/pipeline-tests.sh
+++ b/samples/pipeline-tests.sh
@@ -1,9 +1,9 @@
-seldon model load -f ./models/tfsimple1.yaml 
-seldon model load -f ./models/tfsimple2.yaml 
+seldon model load -f ./models/tfsimple1.yaml
+seldon model load -f ./models/tfsimple2.yaml
 seldon model status tfsimple1 -w ModelAvailable | jq -M .
 seldon model status tfsimple2 -w ModelAvailable | jq -M .
 seldon pipeline load -f ./pipelines/tfsimples.yaml
-seldon pipeline status tfsimples -w PipelineReady| jq -M .
+seldon pipeline status tfsimples -w PipelineReady | jq -M .
 seldon pipeline infer tfsimples '{"inputs":[{"name":"INPUT0","data":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"datatype":"INT32","shape":[1,16]},{"name":"INPUT1","data":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"datatype":"INT32","shape":[1,16]}]}'
 seldon pipeline infer tfsimples --inference-mode grpc '{"model_name":"simple","inputs":[{"name":"INPUT0","contents":{"int_contents":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]},"datatype":"INT32","shape":[1,16]},{"name":"INPUT1","contents":{"int_contents":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]},"datatype":"INT32","shape":[1,16]}]}'
 seldon pipeline unload tfsimples
@@ -11,9 +11,9 @@ seldon model unload tfsimple1
 seldon model unload tfsimple2
 
 
-seldon model load -f ./models/tfsimple1.yaml 
-seldon model load -f ./models/tfsimple2.yaml 
-seldon model load -f ./models/tfsimple3.yaml 
+seldon model load -f ./models/tfsimple1.yaml
+seldon model load -f ./models/tfsimple2.yaml
+seldon model load -f ./models/tfsimple3.yaml
 seldon model status tfsimple1 -w ModelAvailable | jq -M .
 seldon model status tfsimple2 -w ModelAvailable | jq -M .
 seldon model status tfsimple3 -w ModelAvailable | jq -M .
@@ -25,9 +25,9 @@ seldon model unload tfsimple1
 seldon model unload tfsimple2
 seldon model unload tfsimple3
 
-seldon model load -f ./models/conditional.yaml 
-seldon model load -f ./models/add10.yaml 
-seldon model load -f ./models/mul10.yaml 
+seldon model load -f ./models/conditional.yaml
+seldon model load -f ./models/add10.yaml
+seldon model load -f ./models/mul10.yaml
 seldon model status conditional -w ModelAvailable | jq -M .
 seldon model status add10 -w ModelAvailable | jq -M .
 seldon model status mul10 -w ModelAvailable | jq -M .
@@ -41,20 +41,20 @@ seldon model unload add10
 seldon model unload mul10
 
 
-seldon model load -f ./models/outlier-error.yaml 
+seldon model load -f ./models/outlier-error.yaml
 seldon model status outlier-error -w ModelAvailable | jq -M .
 seldon pipeline load -f ./pipelines/error.yaml
 seldon pipeline status error -w PipelineReady | jq -M .
 seldon pipeline infer error --inference-mode grpc     '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[1,2,3,4]},"datatype":"FP32","shape":[4]}]}'
-seldon pipeline infer error --inference-mode grpc     '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[100,2,3,4]},"datatype":"FP32","shape":[4]}]}' 
+seldon pipeline infer error --inference-mode grpc     '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[100,2,3,4]},"datatype":"FP32","shape":[4]}]}'
 seldon pipeline unload error
 seldon model unload outlier-error
 
 
-seldon model load -f ./models/tfsimple1.yaml 
-seldon model load -f ./models/tfsimple2.yaml 
-seldon model load -f ./models/tfsimple3.yaml 
-seldon model load -f ./models/check.yaml 
+seldon model load -f ./models/tfsimple1.yaml
+seldon model load -f ./models/tfsimple2.yaml
+seldon model load -f ./models/tfsimple3.yaml
+seldon model load -f ./models/check.yaml
 seldon model status tfsimple1 -w ModelAvailable | jq -M .
 seldon model status tfsimple2 -w ModelAvailable | jq -M .
 seldon model status tfsimple3 -w ModelAvailable | jq -M .
@@ -70,8 +70,8 @@ seldon model unload tfsimple3
 seldon model unload check
 
 
-seldon model load -f ./models/mul10.yaml 
-seldon model load -f ./models/add10.yaml 
+seldon model load -f ./models/mul10.yaml
+seldon model load -f ./models/add10.yaml
 seldon model status mul10 -w ModelAvailable | jq -M .
 seldon model status add10 -w ModelAvailable | jq -M .
 seldon pipeline load -f ./pipelines/pipeline-inputs.yaml
@@ -82,8 +82,8 @@ seldon model unload mul10
 seldon model unload add10
 
 
-seldon model load -f ./models/mul10.yaml 
-seldon model load -f ./models/add10.yaml 
+seldon model load -f ./models/mul10.yaml
+seldon model load -f ./models/add10.yaml
 seldon model status mul10 -w ModelAvailable | jq -M .
 seldon model status add10 -w ModelAvailable | jq -M .
 seldon pipeline load -f ./pipelines/trigger-joins.yaml
diff --git a/samples/pipeline-to-pipeline.ipynb b/samples/pipeline-to-pipeline.ipynb
index 7ebefc70dd..738b14d1dd 100644
--- a/samples/pipeline-to-pipeline.ipynb
+++ b/samples/pipeline-to-pipeline.ipynb
@@ -182,7 +182,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -356,7 +356,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple-extended -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple-extended -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -665,7 +665,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -1201,7 +1201,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -1746,7 +1746,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -1928,7 +1928,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple-extended-step -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple-extended-step -w PipelineReady | jq -M ."
    ]
   },
   {
@@ -2263,7 +2263,7 @@
     }
    ],
    "source": [
-    "!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
+    "!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
    ]
   },
   {
diff --git a/samples/pipeline-to-pipeline.md b/samples/pipeline-to-pipeline.md
index c41b5b1ea6..e503f54c9c 100644
--- a/samples/pipeline-to-pipeline.md
+++ b/samples/pipeline-to-pipeline.md
@@ -83,7 +83,7 @@ seldon pipeline load -f ./pipelines/tfsimple.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple -w PipelineReady| jq -M .
+seldon pipeline status tfsimple -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -215,7 +215,7 @@ seldon pipeline load -f ./pipelines/tfsimple-extended.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple-extended -w PipelineReady| jq -M .
+seldon pipeline status tfsimple-extended -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -437,7 +437,7 @@ seldon pipeline load -f ./pipelines/tfsimple.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple -w PipelineReady| jq -M .
+seldon pipeline status tfsimple -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -826,7 +826,7 @@ seldon pipeline load -f ./pipelines/tfsimple.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple -w PipelineReady| jq -M .
+seldon pipeline status tfsimple -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -1221,7 +1221,7 @@ seldon pipeline load -f ./pipelines/tfsimple.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple -w PipelineReady| jq -M .
+seldon pipeline status tfsimple -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -1358,7 +1358,7 @@ seldon pipeline load -f ./pipelines/tfsimple-extended-step.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple-extended-step -w PipelineReady| jq -M .
+seldon pipeline status tfsimple-extended-step -w PipelineReady | jq -M .
 ```
 
 ```json
@@ -1597,7 +1597,7 @@ seldon pipeline load -f ./pipelines/tfsimple.yaml
 ```
 
 ```bash
-seldon pipeline status tfsimple -w PipelineReady| jq -M .
+seldon pipeline status tfsimple -w PipelineReady | jq -M .
 ```
 
 ```json
diff --git a/scheduler/notebooks/pipeline-alibi-detect.ipynb b/scheduler/notebooks/pipeline-alibi-detect.ipynb
index 302728736b..2c193dc4cd 100644
--- a/scheduler/notebooks/pipeline-alibi-detect.ipynb
+++ b/scheduler/notebooks/pipeline-alibi-detect.ipynb
@@ -155,7 +155,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!seldon pipeline status -p iris-async-drift -w PipelineReady| jq ."
+    "!seldon pipeline status -p iris-async-drift -w PipelineReady | jq ."
    ]
   },
   {
diff --git a/scheduler/notebooks/pipeline-batch-data-flow-example.ipynb b/scheduler/notebooks/pipeline-batch-data-flow-example.ipynb
index ab5ccbc416..37d8322322 100644
--- a/scheduler/notebooks/pipeline-batch-data-flow-example.ipynb
+++ b/scheduler/notebooks/pipeline-batch-data-flow-example.ipynb
@@ -99,7 +99,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!seldon pipeline status -p iris-batch -w PipelineReady| jq ."
+    "!seldon pipeline status -p iris-batch -w PipelineReady | jq ."
    ]
   },
   {