docs: update the docs (#1826)

redhat-developer · Mar 7, 2023 · 7d6f738 · 7d6f738
1 parent 3acb2de
commit 7d6f738
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 34 deletions.
diff --git a/docs/commands/rhoas.md b/docs/commands/rhoas.md
diff --git a/docs/commands/rhoas_dedicated.md b/docs/commands/rhoas_dedicated.md
diff --git a/docs/commands/rhoas_dedicated_deregister-cluster.md b/docs/commands/rhoas_dedicated_deregister-cluster.md
diff --git a/docs/commands/rhoas_dedicated_list.md b/docs/commands/rhoas_dedicated_list.md
diff --git a/docs/commands/rhoas_dedicated_register-cluster.md b/docs/commands/rhoas_dedicated_register-cluster.md
diff --git a/pkg/core/localize/locales/en/cmd/dedicated.en.toml b/pkg/core/localize/locales/en/cmd/dedicated.en.toml
@@ -3,8 +3,8 @@ one = 'Deregister an OpenShift cluster with Red Hat OpenShift Streams for Apache
 
 [dedicated.deregisterCluster.cmd.longDescription]
 one = '''
-Removes the ability to provision your own kafkas on a cluster, this command will deregister your 
-cluster with Red Hat Streams for Apache Kafka.
+Removes the ability to provision your own Kafka instances on a cluster, this command will deregister your 
+Hybrid cluster with Red Hat OpenShift Streams for Apache Kafka.
 '''
 
 [dedicated.deregisterCluster.cmd.example]
@@ -32,20 +32,20 @@ one = 'No valid OpenShift clusters found.'
 one = 'The cluster ID you have given "{{.ID}}" is not associated with a cluster'
 
 [dedicated.deregisterCluster.deletingKafka.message]
-one = 'The kafka "{{.Name}}" is still deleting'
+one = 'The Kafka instance: "{{.Name}}" is still deleting'
 
 [dedicated.deregisterCluster.deletingKafka.success]
-one = 'All kafkas deleted from cluster'
+one = 'All Kafka instances have been deleted from cluster'
 
 [dedicated.common.addons.deleting.message]
-one = 'Deleting addon from cluster with the id of {{.Id}}'
+one = 'Deleting add-on from cluster with the ID of {{.Id}}'
 
 [dedicated.registerCluster.cmd.shortDescription]
 one = 'Register an OpenShift cluster with Red Hat OpenShift Streams for Apache Kafka'
 
 [dedicated.registerCluster.cmd.longDescription]
 one = '''
-You can use your own OpenShift cluster to provision your kafkas which will be managed by Red Hat Streams for Apache Kafka.
+You can use your own OpenShift cluster to provision your Kafka instances which will be managed by Red Hat Streams for Apache Kafka.
 This command will register your cluster with Red Hat Streams for Apache Kafka.
 '''
 
@@ -55,23 +55,23 @@ one = 'No valid OpenShift clusters found.'
 [dedicated.registerCluster.cmd.example]
 one = '''
 # Register an OpenShift cluster with Red Hat Streams for Apache Kafka by selecting from a list of available clusters.
-rhoas cluster register-cluster
+rhoas dedicated register-cluster
 
 # Register an OpenShift cluster with Red Hat Streams for Apache Kafka by specifying the cluster ID.
-rhoas cluster register-cluster --cluster-id 1234-5678-90ab-cdef
+rhoas dedicated register-cluster --cluster-id 1234-5678-90ab-cdef
 '''
 
 [dedicated.registerCluster.flag.clusterId.description]
 one = 'The ID of the OpenShift cluster to register:'
 
 [dedicated.registerCluster.prompt.selectCluster.message]
-one = 'Select the ready cluster to register'
+one = 'Select the OpenShift cluster to register'
 
 [dedicated.registerCluster.prompt.selectPublicNetworkAccess.message]
 one = 'Would you like your Kafka instances to be accessible via a public network?'
 
 [dedicated.registerCluster.prompt.selectPublicNetworkAccess.help]
-one = 'If you select yes, your Kafka will be accessible via a public network'
+one = 'If you select yes, your Kafka instace will be accessible via a public network'
 
 [dedicated.registerCluster.prompt.createMachinePoolNodeCount.message]
 one = 'Enter the desired machine pool node count'
@@ -87,12 +87,12 @@ There will be N/3 streaming units in your Kafka cluster, where N is the machine
 one = 'Using the valid machine pool:'
 
 [dedicated.cmd.shortDescription]
-one = 'Manage your OpenShift clusters which host your kafkas.'
+one = 'Manage your Hybrid OpenShift clusters which host your Kafka instances.'
 
 [dedicated.cmd.longDescription]
 one = '''
 Red Hat OpenShift Streams for Apache Kafka allows you to use your own OpenShift clusters to provision your
-kafkas. These Kafka instances will be managed by Red Hat OpenShift Streams for Apache Kafka.
+Kafka instances. These Kafka instances will be managed by Red Hat OpenShift Streams for Apache Kafka.
 '''
 
 [dedicated.cmd.example]
@@ -104,17 +104,17 @@ rhoas dedicated register-cluster
 [dedicated.registerCluster.kfmResponse.status.clusterAccepted]
 one = '''
 The cluster has been accepted. Red Hat OpenShift Streams for Apache Kafka control plane is now
-terraforming your cluster for use with your Kafkas.
+terraforming your cluster for use with your Kafka instances.
 '''
 
 [dedicated.deregisterCluster.kafka.delete.warning]
-one = 'To deregister a cluster all kafkas must be deleted'
+one = 'To deregister a Hybrid OpenShift cluster all Kafka instances must be deleted'
 
 [dedicated.deregisterCluster.kafka.delete.failed]
-one = 'There was an unexpected error when deleting the kafka'
+one = 'There was an unexpected error when deleting the Kafka instance'
 
 [dedicated.registerCluster.kfmResponse.status.conflict]
-one = 'The cluster has already been registered with Red Hat OpenShift Streams for Apache Kafka.'
+one = 'This OpenShift cluster has already been registered with Red Hat OpenShift Streams for Apache Kafka.'
 
 [dedicated.registerCluster.flag.clusterMgmtApiUrl.description]
 one = 'The API URL of the OpenShift Cluster Management API.'
@@ -123,18 +123,18 @@ one = 'The API URL of the OpenShift Cluster Management API.'
 one = 'The access token to use to authenticate with the OpenShift Cluster Management API.'
 
 [dedicated.registerCluster.flag.pageNumber.description]
-one = 'The page number to use when listing clusters.'
+one = 'The page number to use when listing Hybrid OpenShift clusters.'
 
 [dedicated.registerCluster.flag.pageSize.description]
-one = 'The page size to use when listing clusters.'
+one = 'The page size to use when listing Hybrid OpenShift clusters.'
 
 [dedicated.list.cmd.shortDescription]
 one = 'List all OpenShift clusters registered with Red Hat OpenShift Streams for Apache Kafka.'
 
 [dedicated.list.cmd.longDescription]
 one = '''
 Red Hat OpenShift Streams for Apache Kafka allows you to use your own OpenShift clusters to provision your
-kafkas. These Kafka instances will be managed by Red Hat OpenShift Streams for Apache Kafka.
+Kafka instances. These Kafka instances will be managed by Red Hat OpenShift Streams for Apache Kafka.
 '''
 
 [dedicated.list.cmd.example]
@@ -144,7 +144,7 @@ rhoas dedicated list
 '''
 
 [dedicated.list.cmd.errorNoRegisteredClusters]
-one = 'No registered clusters found.'
+one = 'No registered OpenShift clusters found.'
 
 [dedicated.list.error.permissionDenied]
 one = 'You do not have permissions to list Hybrid clusters'