Merge pull request #27428 from bergerhoffer/term-updates-cli-odo

bergerhoffer · web-flow · commit d4453ac7c9bf · 2020-12-04T09:44:25.000-05:00
Terminology style updates for odo and helm
diff --git a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc b/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
@@ -5,10 +5,10 @@ include::modules/common-attributes.adoc[]
 :context: creating-instances-of-services-managed-by-operators
 toc::[]
 
-Operators are a method of packaging, deploying, and managing Kubernetes services. With `{odo-title}`, you can create instances of services from the Custom Resource Definitions (CRDs) provided by the Operators. You can then use these instances in your projects and link them to your components.
+Operators are a method of packaging, deploying, and managing Kubernetes services. With `{odo-title}`, you can create instances of services from the custom resource definitions (CRDs) provided by the Operators. You can then use these instances in your projects and link them to your components.
 
 To create services from an Operator, you must ensure that the Operator has valid values defined in its `metadata` to start the requested service. `{odo-title}` uses the `metadata.annotations.alm-examples` YAML file of an Operator to start
-the service. If this YAML has placeholder values or sample values, a service cannot start. You can modify the YAML file and start the service with the modified values. To learn how to modify YAML files and start services from it, go to xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc#creating-services-from-yaml-files_creating-instances-of-services-managed-by-operators[Creating services from YAML files].
+the service. If this YAML has placeholder values or sample values, a service cannot start. You can modify the YAML file and start the service with the modified values. To learn how to modify YAML files and start services from it, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc#creating-services-from-yaml-files_creating-instances-of-services-managed-by-operators[Creating services from YAML files].
 
 == Prerequisites
 * Install the `oc` CLI and log into the cluster.
diff --git a/cli_reference/developer_cli_odo/odo-release-notes.adoc b/cli_reference/developer_cli_odo/odo-release-notes.adoc
@@ -8,20 +8,20 @@ toc::[]
 [id="odo-notable-improvements_{context}"]
 == Notable changes and improvements in `{odo-title}`
 
-* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles]. 
+* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles].
 
 * The default deployment mechanism in `{odo-title}` is the devfile deployment now.
 
-* Added documentation about converting S2I to devfile. See, xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
+* Added documentation about converting S2I to devfile. See xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
 
-* Added commands to display JSON output for devfile components. 
+* Added commands to display JSON output for devfile components.
 
 * `odo debug` is no longer a Technology Preview feature and is now fully supported.
 To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.html#debugging-an-application_debugging-applications-in-odo[Debugging applications in odo].
 
-* `{odo-title}` integration with Operators is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc[Creating instances of services managed by Operators]. 
+* `{odo-title}` integration with Operators is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc[Creating instances of services managed by Operators].
 
-* `{odo-title}` now supports IBM Z. 
+* `{odo-title}` now supports IBM Z.
 
 * Improved and enhanced output for many commands.
 
diff --git a/cli_reference/tkn_cli/op-tkn-reference.adoc b/cli_reference/tkn_cli/op-tkn-reference.adoc
@@ -8,10 +8,10 @@ toc::[]
 
 This section lists the basic `tkn` CLI commands.
 
-== Basic Syntax
+== Basic syntax
 `tkn [command or options] [arguments...]`
 
-== Global Options
+== Global options
 `--help, -h`
 
 // Utility commands
diff --git a/modules/developer-cli-odo-adding-storage-to-the-application-components.adoc b/modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
@@ -17,7 +17,7 @@ Use the `odo storage` command to add persistent data to your application. Exampl
 $ odo storage create <storage_name> --path=<path_to_the_directory> --size=<size>
 ----
 
-. Push the storage to the cluser:
+. Push the storage to the cluster:
 +
 [source,terminal]
 ----
diff --git a/modules/developer-cli-odo-connecting-the-database.adoc b/modules/developer-cli-odo-connecting-the-database.adoc
@@ -26,9 +26,9 @@ Following environment variables were added to nodejs-nodejs-ex-mhbb component:
 - admin_password
 ----
 
-. See the environment variables of the application and the database in the Pod:
+. See the environment variables of the application and the database in the pod:
 
-.. Get the Pod name:
+.. Get the pod name:
 +
 [source,terminal]
 ----
@@ -43,7 +43,7 @@ mongodb-1-gsznc                     1/1       Running   0          28m
 nodejs-nodejs-ex-mhbb-app-4-vkn9l   1/1       Running   0          1m
 ----
 
-.. Connect to the Pod:
+.. Connect to the pod:
 +
 [source,terminal]
 ----
diff --git a/modules/developer-cli-odo-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc b/modules/developer-cli-odo-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc
@@ -26,5 +26,5 @@ $ odo catalog list services
 +
 [source,terminal]
 ----
-$ odo service <verb> <servicename>
+$ odo service <verb> <service_name>
 ----
diff --git a/modules/developer-cli-odo-converting-an-s2i-component-into-a-devfile-component.adoc b/modules/developer-cli-odo-converting-an-s2i-component-into-a-devfile-component.adoc
@@ -5,7 +5,7 @@
 [id="converting-an-s2i-component-into-a-devfile-component_{context}"]
 = Converting an S2I component into a devfile component
 
-With `{odo-title}`, you can create both Source-to-Image (S2I) and devfile components. If you have an existing S2I component, you can convert it into a devfile component using the `odo utils` command. 
+With `{odo-title}`, you can create both Source-to-Image (S2I) and devfile components. If you have an existing S2I component, you can convert it into a devfile component using the `odo utils` command.
 
 .Procedure
 
@@ -15,19 +15,19 @@ Run all the commands from the S2I component directory.
 +
 [source,terminal]
 ----
-$ odo utils convert-to-devfile 
+$ odo utils convert-to-devfile
 ----
 
 . Push the component to your cluster:
 +
 [source,terminal]
 ----
-$ odo push 
+$ odo push
 ----
 +
 [NOTE]
 ====
-If the devfile component deployment failed, delete it by running: `$ odo delete -a`
+If the devfile component deployment failed, delete it by running: `odo delete -a`
 ====
 +
 
diff --git a/modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc b/modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc
@@ -49,7 +49,7 @@ endif::multi[]
 +
 [source,terminal]
 ----
-$ cd <directory name>
+$ cd <directory_name>
 ----
 
 . Add a component of the type Node.js to your application:
@@ -95,7 +95,7 @@ $ odo url list
 +
 [source,terminal]
 ----
-$ curl <URL>
+$ curl <url>
 ----
 
 ifeval::["{context}" == "creating-a-single-component-application-with-odo"]
diff --git a/modules/developer-cli-odo-creating-services-from-yaml-files.adoc b/modules/developer-cli-odo-creating-services-from-yaml-files.adoc
@@ -6,7 +6,7 @@
 
 = Creating services from YAML files
 
-If the YAML definition of the service or Custom Resource (CR) has invalid or placeholder data, you can use the `--dry-run` flag to get the YAML definition, specify the correct values, and start the service using the corrected YAML definition.
+If the YAML definition of the service or custom resource (CR) has invalid or placeholder data, you can use the `--dry-run` flag to get the YAML definition, specify the correct values, and start the service using the corrected YAML definition.
 Printing and modifying the YAML used to start a service
 `{odo-title}` provides the feature to print the YAML definition of the service or CR provided by the Operator before starting a service.
 
diff --git a/modules/developer-cli-odo-deploying-the-back-end-component.adoc b/modules/developer-cli-odo-deploying-the-back-end-component.adoc
@@ -181,7 +181,7 @@ Pushing to component backend of type binary
  ✓  Building component [3s]
 ----
 +
-Using `odo push`, {product-title} creates a container to host the back-end component, deploys the container into a Pod running on the {product-title} cluster, and starts the `backend` component.
+Using `odo push`, {product-title} creates a container to host the back-end component, deploys the container into a pod running on the {product-title} cluster, and starts the `backend` component.
 
 . Validate:
 
diff --git a/modules/developer-cli-odo-exposing-the-components-to-the-public.adoc b/modules/developer-cli-odo-exposing-the-components-to-the-public.adoc
@@ -59,11 +59,11 @@ Pushing to component frontend of type local
 
 [NOTE]
 ====
-If an application requires permissions to the active Service Account to access the {product-title} namespace and delete active pods, the following error may occur when looking at `odo log` from the back-end component:
+If an application requires permissions to the active service account to access the {product-title} namespace and delete active pods, the following error may occur when looking at `odo log` from the back-end component:
 
 `Message: Forbidden!Configured service account doesn't have access. Service account may have been revoked`
 
-To resolve this error, add permissions for the Service Account role:
+To resolve this error, add permissions for the service account role:
 
 [source,terminal]
 ----
diff --git a/modules/developer-cli-odo-installing-odo-on-windows.adoc b/modules/developer-cli-odo-installing-odo-on-windows.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/developer_cli_odo/installing-odo.adoc     
+// * cli_reference/developer_cli_odo/installing-odo.adoc
 
 [id="installing-odo-on-windows_{context}"]
 
@@ -14,7 +14,7 @@
 [discrete]
 == Setting the `PATH` variable for Windows 7/8
 
-The following example demonstrates how to set up a path variable. Your binaries can be located in any location, but this example uses C:\go-bin as the location.
+The following example demonstrates how to set up a path variable. Your binaries can be located in any location, but this example uses `C:\go-bin` as the location.
 
 . Create a folder at `C:\go-bin`.
 . Right click *Start* and click *Control Panel*.
diff --git a/modules/developer-cli-odo-linking-both-components.adoc b/modules/developer-cli-odo-linking-both-components.adoc
@@ -19,14 +19,14 @@ $ odo list
 .Example output
 [source,terminal]
 ----
-OpenShift Components: 
+OpenShift Components:
 APP     NAME         PROJECT     TYPE          SOURCETYPE     STATE
 app     backend      testpro     openjdk18     binary         Pushed
 app     frontend     testpro     nodejs        local          Pushed
 ----
 
 
-. Link the current front-end component to the backend:
+. Link the current front-end component to the back end:
 +
 [source,terminal]
 ----
diff --git a/modules/developer-cli-odo-openshift-cluster-objects.adoc b/modules/developer-cli-odo-openshift-cluster-objects.adoc
@@ -15,9 +15,9 @@ The pod created by {odo-title} executes two Init Containers:
 
 === `copy-supervisord`
 
-The `copy-supervisord` Init container copies necessary files onto an `emptyDir` Volume. The main application container utilizes these files from the `emptyDir` Volume.
+The `copy-supervisord` Init container copies necessary files onto an `emptyDir` volume. The main application container utilizes these files from the `emptyDir` volume.
 
-.Files that are copied onto the `emptyDir` Volume:
+.Files that are copied onto the `emptyDir` volume:
 * Binaries:
 ** `go-init` is a minimal init system. It runs as the first process (PID 1) inside the application container. go-init starts the `SupervisorD` daemon which runs the developer code. go-init is required to handle orphaned processes.
 ** `SupervisorD` is a process control system. It watches over configured processes and ensures that they are running. It also restarts services when necessary. For {odo-title}, `SupervisorD` executes and monitors the developer code.
@@ -32,52 +32,52 @@ The `copy-supervisord` Init container copies necessary files onto an `emptyDir`
 * Directories:
 ** `language-scripts`: OpenShift S2I allows custom `assemble` and `run` scripts. A few language specific custom scripts are present in the `language-scripts` directory. The custom scripts provide additional configuration to make {odo-title} debug work.
 
-The `emtpyDir Volume` is mounted at the `/opt/odo` mount point for both the Init container and the application container.
+The `emptyDir` volume is mounted at the `/opt/odo` mount point for both the Init container and the application container.
 
 === `copy-files-to-volume`
-The `copy-files-to-volume` Init container copies files that are in `/opt/app-root` in the S2I builder image onto the Persistent Volume. The volume is then mounted at the same location (`/opt/app-root`) in an application container.
+The `copy-files-to-volume` Init container copies files that are in `/opt/app-root` in the S2I builder image onto the persistent volume. The volume is then mounted at the same location (`/opt/app-root`) in an application container.
 
-Without the `PersistentVolume` on `/opt/app-root` the data in this directory is lost when `PersistentVolumeClaim` is mounted at the same location.
+Without the persistent volume on `/opt/app-root` the data in this directory is lost when the persistent volume claim is mounted at the same location.
 
-The `PVC` is mounted at the `/mnt` mount point inside the Init container.
+The PVC is mounted at the `/mnt` mount point inside the Init container.
 
 == Application container
 Application container is the main container inside of which the user-source code executes.
 
-Application container is mounted with two Volumes:
+Application container is mounted with two volumes:
 
-* `emptyDir` Volume mounted at `/opt/odo`
-* The `PersistentVolume` mounted at `/opt/app-root`
+* `emptyDir` volume mounted at `/opt/odo`
+* The persistent volume mounted at `/opt/app-root`
 
 `go-init` is executed as the first process inside the application container. The `go-init` process then starts the `SupervisorD` daemon.
 
-`SupervisorD` executes and monitores the user assembled source code. If the user process crashes, `SupervisorD` restarts it.
+`SupervisorD` executes and monitors the user assembled source code. If the user process crashes, `SupervisorD` restarts it.
 
-== `PersistentVolume` and `PersistentVolumeClaim`
-`PersistentVolumeClaim` (`PVC`) is a volume type in Kubernetes which provisions a `PersistentVolume`. The life of a `PersistentVolume` is independent of a pod lifecycle. The data on the `PersistentVolume` persists across pod restarts.
+== Persistent volumes and persistent volume claims
+A persistent volume claim (PVC) is a volume type in Kubernetes which provisions a persistent volume. The life of a persistent volume is independent of a pod lifecycle. The data on the persistent volume persists across pod restarts.
 
-The `copy-files-to-volume` Init container copies necessary files onto the `PersistentVolume`. The main application container utilizes these files at runtime for execution.
+The `copy-files-to-volume` Init container copies necessary files onto the persistent volume. The main application container utilizes these files at runtime for execution.
 
-The naming convention of the `PersistentVolume` is <component-name>-s2idata.
+The naming convention of the persistent volume is <component_name>-s2idata.
 
 [options="header"]
 |===
-| Container | `PVC Mounted` at
+| Container | PVC mounted at
 | `copy-files-to-volume`
 | `/mnt`
 
 | Application container
 | `/opt/app-root`
 |===
 
-== `emptyDir` Volume
-An `emptyDir` Volume is created when a pod is assigned to a node, and exists as long as that pod is running on the node. If the container is restarted or moved, the content of the `emptyDir` is removed, Init container restores the data back to the `emptyDir`. `emptyDir` is initially empty.
+== `emptyDir` volume
+An `emptyDir` volume is created when a pod is assigned to a node, and exists as long as that pod is running on the node. If the container is restarted or moved, the content of the `emptyDir` is removed, Init container restores the data back to the `emptyDir`. `emptyDir` is initially empty.
 
 The `copy-supervisord` Init container copies necessary files onto the `emptyDir` volume. These files are then utilized by the main application container at runtime for execution.
 
 [options="header"]
 |===
-| Container | `emptyDir Volume` Mounted at
+| Container | `emptyDir volume` mounted at
 | `copy-supervisord`
 | `/opt/odo`
 
@@ -86,6 +86,6 @@ The `copy-supervisord` Init container copies necessary files onto the `emptyDir`
 |===
 
 == Service
-Service is a Kubernetes concept of abstracting the way of communicating with a set of pods.
+A service is a Kubernetes concept of abstracting the way of communicating with a set of pods.
 
-{odo-title} creates a Service for every application pod to make it accessible for communication.
+{odo-title} creates a service for every application pod to make it accessible for communication.
diff --git a/modules/developer-cli-odo-push-workflow.adoc b/modules/developer-cli-odo-push-workflow.adoc
@@ -11,26 +11,26 @@ This section describes `{odo-title} push` workflow. {odo-title} push deploys use
 +
 If not already created, `{odo-title} push` creates the following {product-title} resources:
 +
-* Deployment config (DC):
+* `DeploymentConfig` object:
 ** Two init containers are executed: `copy-supervisord` and `copy-files-to-volume`. The init containers copy files onto the `emptyDir` and the `PersistentVolume` type of volumes respectively.
 ** The application container starts. The first process in the application container is the `go-init` process with PID=1.
 ** `go-init` process starts the SupervisorD daemon.
 +
 [NOTE]
 ====
-The user application code has not been copied into the application container yet, so the `SupervisorD` daemon does not execute the `run` script. 
+The user application code has not been copied into the application container yet, so the `SupervisorD` daemon does not execute the `run` script.
 ====
 +
-* Service
-* Secrets
-* `PersistentVolumeClaim`
+* `Service` object
+* `Secret` objects
+* `PersistentVolumeClaim` object
 
 
 . Indexing files
 +
 * A file indexer indexes the files in the source code directory. The indexer traverses through the source code directories recursively and finds files which have been created, deleted, or renamed.
 * A file indexer maintains the indexed information in an {odo-title} index file inside the `.odo` directory.
-* If the {odo-title} index file is not present, it means that the file indexer is being executed for the first time, and creates a new {odo-title} index JSON file. 
+* If the {odo-title} index file is not present, it means that the file indexer is being executed for the first time, and creates a new {odo-title} index JSON file.
 The {odo-title} index JSON file contains a file map - the relative file paths of the traversed files and the absolute paths of the changed and deleted files.
 
 . Pushing code
@@ -39,4 +39,4 @@ Local code is copied into the application container, usually under `/tmp/src`.
 
 . Executing `assemble-and-restart`
 +
-On a successful copy of the source code, the `assemble-and-restart` script is executed inside the running application container.
+On a successful copy of the source code, the `assemble-and-restart` script is executed inside the running application container.
diff --git a/modules/developer-cli-odo-using-command-completion.adoc b/modules/developer-cli-odo-using-command-completion.adoc
@@ -24,7 +24,7 @@ $ odo --complete
 +
 .  Press `y` when prompted to install the completion hook.
 
-* To install the completion hook manually, add `complete -o nospace -C <full path to your odo binary> odo` to your shell configuration file. After any modification to your shell configuration file, restart your shell.
+* To install the completion hook manually, add `complete -o nospace -C <full_path_to_your_odo_binary> odo` to your shell configuration file. After any modification to your shell configuration file, restart your shell.
 
 * To disable completion:
 . Run:
diff --git a/modules/helm-adding-helm-chart-repositories.adoc b/modules/helm-adding-helm-chart-repositories.adoc
@@ -9,11 +9,11 @@ You can add custom Helm chart repositories to your cluster, and enable access to
 
 .Procedure
 
-. To add a new Helm Chart Repository, you must add the Helm Chart Repository Custom Resource (CR) to your cluster.
+. To add a new Helm Chart Repository, you must add the Helm Chart Repository custom resource (CR) to your cluster.
 +
 .Sample Helm Chart Repository CR
 
-[Source,yaml]
+[source,yaml]
 ----
 apiVersion: helm.openshift.io/v1beta1
 kind: HelmChartRepository
diff --git a/modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc b/modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc
diff --git a/modules/helm-installing-helm.adoc b/modules/helm-installing-helm.adoc

Original file line number	Diff line number	Diff line change
@@ -17,7 +17,7 @@ Use the `odo storage` command to add persistent data to your application. Exampl
`17`	`17`	`$ odo storage create <storage_name> --path=<path_to_the_directory> --size=<size>`
`18`	`18`	`----`
`19`	`19`
`20`		`-. Push the storage to the cluser:`
	`20`	`+. Push the storage to the cluster:`
`21`	`21`	`+`
`22`	`22`	`[source,terminal]`
`23`	`23`	`----`
Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,5 @@ $ odo catalog list services`
`26`	`26`	`+`
`27`	`27`	`[source,terminal]`
`28`	`28`	`----`
`29`		`-$ odo service <verb> <servicename>`
	`29`	`+$ odo service <verb> <service_name>`
`30`	`30`	`----`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ Pushing to component backend of type binary`
`181`	`181`	`✓ Building component [3s]`
`182`	`182`	`----`
`183`	`183`	`+`
`184`		-Using `odo push`, {product-title} creates a container to host the back-end component, deploys the container into a Pod running on the {product-title} cluster, and starts the `backend` component.
	`184`	+Using `odo push`, {product-title} creates a container to host the back-end component, deploys the container into a pod running on the {product-title} cluster, and starts the `backend` component.
`185`	`185`
`186`	`186`	`. Validate:`
`187`	`187`