From c348824e95ad88eec1f5519efff306bf837af947 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Wed, 27 Jul 2022 14:30:41 -0400 Subject: [PATCH] fix based on review --- .../command-reference/create-namespace.md | 2 ++ .../command-reference/delete-namespace.md | 2 ++ .../command-reference/describe-binding.md | 3 +++ docs/website/docs/command-reference/dev.md | 3 +++ docs/website/docs/command-reference/init.md | 4 ++++ .../docs/command-reference/list-binding.md | 1 + .../docs/command-reference/list-namespace.md | 2 ++ .../docs/command-reference/registry.md | 15 ++++++++++----- .../docs/command-reference/set-namespace.md | 2 ++ docs/website/docs/user-guides/quickstart.md | 19 +++++++++++++++++-- 10 files changed, 46 insertions(+), 7 deletions(-) diff --git a/docs/website/docs/command-reference/create-namespace.md b/docs/website/docs/command-reference/create-namespace.md index 78909911ae1..75e6004e397 100644 --- a/docs/website/docs/command-reference/create-namespace.md +++ b/docs/website/docs/command-reference/create-namespace.md @@ -11,6 +11,7 @@ To create a namespace you can run `odo create namespace `: odo create namespace mynamespace ``` ```shell +$ odo create namespace mynamespace ✓ Namespace "mynamespace" is ready for use ✓ New namespace created and now using namespace: mynamespace ``` @@ -22,6 +23,7 @@ To create a project you can run `odo create project `: odo create project myproject ``` ```shell +$ odo create project myproject ✓ Project "myproject" is ready for use ✓ New project created and now using project: myproject ``` diff --git a/docs/website/docs/command-reference/delete-namespace.md b/docs/website/docs/command-reference/delete-namespace.md index 74bcf36fff8..5d9274816b6 100644 --- a/docs/website/docs/command-reference/delete-namespace.md +++ b/docs/website/docs/command-reference/delete-namespace.md @@ -9,6 +9,7 @@ To delete a namespace you can run `odo delete namespace `: odo delete namespace mynamespace ``` ```shell +$ odo delete namespace mynamespace ✓ Namespace "mynamespace" deleted ``` @@ -19,6 +20,7 @@ To delete a project you can run `odo delete project `: odo delete project myproject ``` ```shell +$ odo delete project myproject ✓ Project "myproject" deleted ``` diff --git a/docs/website/docs/command-reference/describe-binding.md b/docs/website/docs/command-reference/describe-binding.md index 4cef764cf91..19a72224b3c 100644 --- a/docs/website/docs/command-reference/describe-binding.md +++ b/docs/website/docs/command-reference/describe-binding.md @@ -39,6 +39,7 @@ When the service binding are not deployed yet to the cluster: odo describe binding ``` ```console +$ odo describe binding ServiceBinding used by the current component: Service Binding Name: my-nodejs-app-cluster-sample @@ -66,6 +67,7 @@ When the resources have been deployed to the cluster, the command also extracts odo describe binding ``` ```console +$ odo describe binding ServiceBinding used by the current component: Service Binding Name: my-nodejs-app-cluster-sample-2 @@ -106,6 +108,7 @@ Available binding information: odo describe binding --name ``` +$ odo describe binding --name The command extracts information from the cluster. The command searches for a resource in the current namespace with the given name, the kind `ServiceBinding` and one of these apiVersion: diff --git a/docs/website/docs/command-reference/dev.md b/docs/website/docs/command-reference/dev.md index 7d9c6784c62..6035b4fe96e 100644 --- a/docs/website/docs/command-reference/dev.md +++ b/docs/website/docs/command-reference/dev.md @@ -18,6 +18,7 @@ Afterwards, run `odo dev`: odo dev ``` ```console +$ odo dev __ / \__ Developing using the my-nodejs-app Devfile \__/ \ Namespace: default @@ -79,6 +80,7 @@ For example, given the following excerpt from a Devfile: odo dev --build-command my-build-with-version ``` ```console +$ odo dev --build-command my-build-with-version __ / \__ Developing using the my-sample-go Devfile @@ -134,6 +136,7 @@ For example, given the following excerpt from a Devfile: odo dev --run-command my-run-with-postgres ``` ```console +$ odo dev --run-command my-run-with-postgres __ / \__ Developing using the my-java-springboot-app Devfile diff --git a/docs/website/docs/command-reference/init.md b/docs/website/docs/command-reference/init.md index 2dda6e19675..a2fe6c877d9 100644 --- a/docs/website/docs/command-reference/init.md +++ b/docs/website/docs/command-reference/init.md @@ -37,6 +37,7 @@ The required `--name` flag indicates how the component initialized by this comma odo init ``` ```console +$ odo init ? Select language: java ? Select project type: Maven Java (java-maven, registry: DefaultDevfileRegistry) ? Which starter project do you want to use? springbootproject @@ -58,6 +59,7 @@ In this example, the devfile will be downloaded from the **Staging** registry, w odo preference view ``` ```console +$ odo preference view Preference parameters: PARAMETER VALUE ConsentTelemetry true @@ -90,6 +92,7 @@ In this example, the devfile will be downloaded from the **DefaultDevfileRegistr odo preference view ``` ```console +$ odo preference view Preference parameters: PARAMETER VALUE ConsentTelemetry true @@ -120,6 +123,7 @@ To deploy your component to a cluster use "odo deploy". odo init --devfile-path https://registry.devfile.io/devfiles/nodejs-angular --name my-nodejs-app --starter nodejs-angular-starter ``` ```console +$ odo init --devfile-path https://registry.devfile.io/devfiles/nodejs-angular --name my-nodejs-app --starter nodejs-angular-starter ✓ Downloading devfile from "https://registry.devfile.io/devfiles/nodejs-angular" [415ms] ✓ Downloading starter project "nodejs-angular-starter" [484ms] diff --git a/docs/website/docs/command-reference/list-binding.md b/docs/website/docs/command-reference/list-binding.md index 12d643d2f03..f0d477d4797 100644 --- a/docs/website/docs/command-reference/list-binding.md +++ b/docs/website/docs/command-reference/list-binding.md @@ -23,6 +23,7 @@ To list all the service bindings, you can run `odo list binding`: odo list binding ``` ```console +$ odo list binding NAME APPLICATION SERVICES RUNNING IN binding-to-redis my-nodejs-app-app (Deployment) redis (Service) Dev * my-nodejs-app-cluster-sample my-nodejs-app-app (Deployment) cluster-sample (Cluster.postgresql.k8s.enterprisedb.io) (namespace: shared-ns-1) Dev diff --git a/docs/website/docs/command-reference/list-namespace.md b/docs/website/docs/command-reference/list-namespace.md index d4a9f934480..a7ffc9452cd 100644 --- a/docs/website/docs/command-reference/list-namespace.md +++ b/docs/website/docs/command-reference/list-namespace.md @@ -15,6 +15,7 @@ To list all the namespaces, you can run `odo list namespace`: odo list namespace ``` ```console +$ odo list namespace ACTIVE NAME * default kube-node-lease @@ -33,6 +34,7 @@ ACTIVE NAME odo list project ``` ```console + $ odo list project ACTIVE NAME * default kube-node-lease diff --git a/docs/website/docs/command-reference/registry.md b/docs/website/docs/command-reference/registry.md index 1688531a52a..66d2e05bcaa 100644 --- a/docs/website/docs/command-reference/registry.md +++ b/docs/website/docs/command-reference/registry.md @@ -30,10 +30,11 @@ This flag lets you change the content of the output: For these examples, we consider we have two registries in our preferences: -```shell +```console odo preference view ``` ```console +$ odo preference view Preference parameters: PARAMETER VALUE ConsentTelemetry true @@ -51,10 +52,11 @@ Devfile registries: To get the complete list of accessible Devfile stacks: -```shell +```console odo registry ``` ```console +$ odo registry NAME REGISTRY DESCRIPTION dotnet50 Staging Stack with .NET 5.0 dotnet50 DefaultDevfileRegistry Stack with .NET 5.0 @@ -71,10 +73,11 @@ odo registry To list the Devfile stacks from the Staging registry only: -```shell +```console odo registry --devfile-registry Staging ``` ```console +$ odo registry --devfile-registry Staging NAME REGISTRY DESCRIPTION dotnet50 Staging Stack with .NET 5.0 dotnet60 Staging Stack with .NET 6.0 @@ -86,10 +89,11 @@ odo registry --devfile-registry Staging To list the Devfile stacks related to Maven: -```shell +```console odo registry --filter Maven ``` ```console +$ odo registry --filter Maven NAME REGISTRY DESCRIPTION java-maven Staging Upstream Maven and OpenJDK 11 java-maven DefaultDevfileRegistry Upstream Maven and OpenJDK 11 @@ -103,10 +107,11 @@ odo registry --filter Maven To get the details of the `java-maven` Devfile in the Staging registry: -```shell +```console odo registry --devfile java-maven --devfile-registry Staging --details ``` ```console +$ odo registry --devfile java-maven --devfile-registry Staging --details Name: java-maven Display Name: Maven Java Registry: Staging diff --git a/docs/website/docs/command-reference/set-namespace.md b/docs/website/docs/command-reference/set-namespace.md index b5528c57047..d4e7b13cca5 100644 --- a/docs/website/docs/command-reference/set-namespace.md +++ b/docs/website/docs/command-reference/set-namespace.md @@ -11,6 +11,7 @@ To set the current active namespace you can run `odo set namespace `: odo set namespace mynamespace ``` ```console +$ odo set namespace mynamespace ✓ Current active namespace set to "mynamespace" ``` @@ -21,6 +22,7 @@ To set the current active project you can run `odo set project `: odo set project myproject ``` ```console +$ odo set project myproject ✓ Current active project set to "myproject" ``` diff --git a/docs/website/docs/user-guides/quickstart.md b/docs/website/docs/user-guides/quickstart.md index 510b1d8caa6..40be36ee8fd 100644 --- a/docs/website/docs/user-guides/quickstart.md +++ b/docs/website/docs/user-guides/quickstart.md @@ -43,7 +43,8 @@ npm install express --save ```console npx express-generator ``` -```sh +```console +$ npx express-generator warning: the default view engine will not be jade in future releases warning: use `--view=jade' or `--help' for additional options @@ -83,9 +84,10 @@ npx express-generator 1. Generate an example project: ```console -$ dotnet new mvc --name app +dotnet new mvc --name app ``` ```console +$ dotnet new mvc --name app Welcome to .NET 6.0! --------------------- SDK Version: 6.0.104 @@ -168,6 +170,7 @@ Let's run `odo init` and select Node.js: odo init ``` ```console +$ odo init __ / \__ Initializing new component \__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection @@ -205,6 +208,7 @@ Let's run `odo init` and select .NET 6.0: odo init ``` ```console +$ odo init __ / \__ Initializing new component \__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection @@ -247,6 +251,7 @@ Let's run `odo init` and select Java Spring Boot: odo init ``` ```console +$ odo init __ / \__ Initializing new component \__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection @@ -287,6 +292,7 @@ Let's run `odo init` and select Go: odo init ``` ```console +$ odo init __ / \__ Initializing new component \__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection @@ -333,6 +339,7 @@ Let's run `odo dev` to start development on your Node.JS application: odo dev ``` ```console +$ odo dev __ / \__ Developing using the my-nodejs-app Devfile \__/ \ Namespace: default @@ -361,6 +368,7 @@ Let's run `odo dev` to start development on your .NET application: odo dev ``` ```console +$ odo dev __ / \__ Developing using the my-dotnet60-app Devfile \__/ \ Namespace: default @@ -388,6 +396,7 @@ Let's run `odo dev` to start development on your Java Spring Boot application: odo dev ``` ```console +$ odo dev __ / \__ Developing using the my-java-springboot-app Devfile \__/ \ Namespace: default @@ -418,6 +427,7 @@ Let's run `odo dev` to start development on your .NET application: odo dev ``` ```console +$ odo dev __ / \__ Developing using the my-go-app Devfile \__/ \ Namespace: default @@ -659,6 +669,7 @@ Now we're ready to run `odo deploy`: odo deploy ``` ```console +$ odo deploy __ / \__ Deploying the application using my-nodejs-app Devfile \__/ \ Namespace: default @@ -860,6 +871,7 @@ Now we're ready to run `odo deploy`: odo deploy ``` ```console +$ odo deploy __ / \__ Deploying the application using my-dotnet-app Devfile \__/ \ Namespace: default @@ -1059,6 +1071,7 @@ Now we're ready to run `odo deploy`: odo deploy ``` ```console +$ odo deploy __ / \__ Deploying the application using my-java-springboot-app Devfile \__/ \ Namespace: default @@ -1269,6 +1282,7 @@ Now we're ready to run `odo deploy`: odo deploy ``` ```console +$ odo deploy __ / \__ Deploying the application using my-go-app Devfile \__/ \ Namespace: default @@ -1311,6 +1325,7 @@ After testing your application, you may optionally undeploy using the `odo delet odo delete component ``` ```console +$ odo delete component Searching resources to delete, please wait... This will delete "my-app" from the namespace "default". • The component contains the following resources that will get deleted: