From 4c89ec73a6bc592ce5c14d7e1b737dcaf57beb4d Mon Sep 17 00:00:00 2001 From: Ava <170544612+Ava-91@users.noreply.github.com> Date: Fri, 4 Sep 2026 16:41:16 +0330 Subject: [PATCH 1/4] docs: remove shell prompts from README Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6171bfc00..cc06954c2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Before installation, ensure that OLM has been deployed on your cluster by follow Once OLM has been deployed, use the following command to install the latest operator release from [operatorhub.io](https://operatorhub.io/operator/shipwright-operator): ```sh -$ kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml +kubectl apply -f https://operatorhub.io/install/shipwright-operator.yaml ``` ## Prerequisites From 7de7f6757dcc37e04cd77912803b4179e09ea1d2 Mon Sep 17 00:00:00 2001 From: Ava <170544612+Ava-91@users.noreply.github.com> Date: Fri, 4 Sep 2026 16:41:25 +0330 Subject: [PATCH 2/4] docs: remove shell prompts from local development guide Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com> --- docs/development/local-development.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/development/local-development.md b/docs/development/local-development.md index 1a5f00ace..65f7c6cb9 100644 --- a/docs/development/local-development.md +++ b/docs/development/local-development.md @@ -38,21 +38,21 @@ To test the operator on a Kubernetes cluster, you first must have the following: * Install [Tekton operator](https://github.com/tektoncd/operator) v0.74.0 or higher on the cluster. ```bash -$ export KUBECONFIG=/path/to/kubeconfig -$ kubectl apply -f https://github.com/tektoncd/operator/releases/download/v0.74.0/release.notags.yaml +export KUBECONFIG=/path/to/kubeconfig +kubectl apply -f https://github.com/tektoncd/operator/releases/download/v0.74.0/release.notags.yaml ``` If pushing to an external image registry, you may need to provide credentials to ko: ```bash -$ make ko -$ ko login -u -p +make ko +ko login -u -p ``` Next, use the `make deploy` command with appropriate `IMAGE_REPO` and `VERSION` arguments to deploy the operator to the cluster. ```bash -$ make deploy IMAGE_REPO="/" VERSION="" +make deploy IMAGE_REPO="/" VERSION="" ``` _Note:_ @@ -60,5 +60,5 @@ _Note:_ Scripts in `hack` folder may require `sed` (GNU), therefore in platforms other than Linux you may have it with a different name. For instance, on macOS it's usually named `gsed`, in this case provide the `SED_BIN` make variable with the alternative name. ```bash -$ make build SED_BIN=gsed ... +make build SED_BIN=gsed ... ``` From 3d01e9d0d0481d11f5189b49d51cc3d6e870b597 Mon Sep 17 00:00:00 2001 From: Ava <170544612+Ava-91@users.noreply.github.com> Date: Fri, 4 Sep 2026 16:41:34 +0330 Subject: [PATCH 3/4] docs: remove shell prompts from OLM development guide Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com> --- docs/development/olm-development.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/development/olm-development.md b/docs/development/olm-development.md index 6cedbcd5b..96d1ff7c5 100644 --- a/docs/development/olm-development.md +++ b/docs/development/olm-development.md @@ -66,8 +66,8 @@ Like Step 2 above, you will need to publish a catalog containing the candidate o Run the following command to set the correct `BUNDLE_IMG` for the catalog: ```sh -$ version= # example: 0.13.0-rc0 -$ make catalog-push IMAGE_REPO= VERSION="$version" BUNDLE_IMG="ghcr.io/shipwright-io/operator/operator-bundle:v$version" +version= # example: 0.13.0-rc0 +make catalog-push IMAGE_REPO= VERSION="$version" BUNDLE_IMG="ghcr.io/shipwright-io/operator/operator-bundle:v$version" ``` ### Step 2: Deploy the operator @@ -75,8 +75,8 @@ $ make catalog-push IMAGE_REPO= VERSION="$version" BUNDLE_IMG="gh Similar to Step 3 above, deploy the operator with the catalog image: ```sh -$ version= # example: 0.13.0-rc0 -$ make catalog-run IMAGE_REPO= VERSION="$version" +version= # example: 0.13.0-rc0 +make catalog-run IMAGE_REPO= VERSION="$version" ``` ## Troubleshooting @@ -88,7 +88,7 @@ On platforms other than Linux, use the `SED_BIN` make variable to use a differen For instance, on MacOS sed functions are provided by `gsed`: ```bash -$ make catalog-run SED_BIN=gsed ... +make catalog-run SED_BIN=gsed ... ``` ### Catalog Source Fails - Cannot Access Registry Over grpc @@ -100,6 +100,6 @@ To fall back to HTTP-based pull, set the `USE-HTTP` make variable to `true` when the test catalog: ```bash -$ make catalog-push USE-HTTP="true" ... -$ make catalog-run ... +make catalog-push USE-HTTP="true" ... +make catalog-run ... ``` From ca3f7cbd90434c061e721414f73ebfa2c3473409 Mon Sep 17 00:00:00 2001 From: Ava <170544612+Ava-91@users.noreply.github.com> Date: Fri, 4 Sep 2026 16:41:43 +0330 Subject: [PATCH 4/4] docs: remove shell prompts from release guide Signed-off-by: Ava <170544612+Ava-91@users.noreply.github.com> --- docs/development/releasing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/releasing.md b/docs/development/releasing.md index bca10e25c..45a24422e 100644 --- a/docs/development/releasing.md +++ b/docs/development/releasing.md @@ -94,7 +94,7 @@ The OperatorHub release script requires the following: 3. Add the community operators repository as the `upstream` remote: ```sh - $ git remote add upstream https://github.com/k8s-operatorhub/community-operators.git + git remote add upstream https://github.com/k8s-operatorhub/community-operators.git ``` 4. Install the [crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md)