docs: improve help text in commands by craicoverflow · Pull Request #281 · redhat-developer/app-services-cli

craicoverflow · 2021-01-25T14:11:14Z

No description provided.

wtrocki · 2021-01-25T14:17:17Z

Looking at this now.. Will need some time

wtrocki · 2021-01-25T14:36:41Z

docs/commands/rhoas_kafka_describe.adoc

+
+Pass the –id flag to specify which instance you would like to view.
+
+If the –id flag is not passed then the selected Kafka instance will be


[Optional] -id flag when reading in cli blends with text more than "id" flag. or something :D

wtrocki · 2021-01-25T14:37:25Z

docs/commands/rhoas_login.adoc

-Log in to the RHOAS CLI
+Log in securely to RHOAS using your web browser.
+
+Your web browser will open automatically where you can securely enter


Suggested change

Your web browser will open automatically where you can securely enter

Your web browser will open a new tab automatically where you can securely enter

craicoverflow · 2021-01-25T14:37:38Z

Yes but no not merge, still adding to it.

wtrocki · 2021-01-25T14:38:08Z

docs/commands/rhoas_serviceaccount_reset-credentials.adoc


-Generate new SASL/PLAIN credentials for a service account and revoke the
-old credentials
+Reset the SASL/PLAIN credentials for a service account.


Suggested change

Reset the SASL/PLAIN credentials for a service account.

Reset the service credentials for a service account.

This is not only about Managed Kafka

Yeah but they are still SASL/PLAIN credentials. Am I wrong in saying this is not a specific Kafka standard??

https://tools.ietf.org/html/rfc4616

Completely irelevant. Service account is generic. It is just implementation details that they could be used to reach out managed kafka, but this sentence will outdate once other services will be added and also will be reachable using the same credentials.

Good point.

wtrocki · 2021-01-25T14:38:18Z

docs/commands/rhoas_serviceaccount_reset-credentials.adoc

-old credentials
+Reset the SASL/PLAIN credentials for a service account.
+
+This command will generate a new SASL/PLAIN password for a service


Same as above

wtrocki · 2021-01-25T14:39:24Z

pkg/cmd/kafka/delete/delete.go

+		Long: heredoc.Doc(`
+			Permanently delete a Kafka instance.
+
+			You can only delete Kafka instances that you created.


Suggested change

You can only delete Kafka instances that you created.

Let's not bake in current qa env limitations to the CLi that will be typically used with production where this assumption is not true.

wtrocki · 2021-01-25T14:39:42Z

pkg/cmd/kafka/describe/describe.go

+		Long: heredoc.Doc(`
+			View all configuration fields and their values for a Kafka instance.
+
+			Pass the --id flag to specify which instance you would like to view.


Same as above -id blends in.

Not sure what you mean by bends in

"-id" to expose it

I still don't fully understand. What is the suggested action?

pkg/cmd/kafka/describe/describe.go

wtrocki · 2021-01-25T14:42:31Z

pkg/cmd/kafka/status/status.go

+			$ rhoas kafka status
+
+			# view the status of a Kafka instance using its ID
+			$ rhoas kafka status --id "1nYlgkt87xelHT1wnOdEyGhFhaO"


This is strange. Should status show only used kafka. Then how is that different than describe then? Confusion can happen

There is very little difference between "status" and "describe". I will create an issue to discuss its value.

when I think about it yes.. That is the main confusion.

Issue created: #283

wtrocki · 2021-01-25T14:43:09Z

pkg/cmd/kafka/use/use.go

+		Long: heredoc.Doc(`
+			Select a Kafka instance and set it in the config as the current Kafka instance.
+
+			Once a Kafka instance is in use, it becomes the "current" instance. 


Suggested change

Once a Kafka instance is in use, it becomes the "current" instance.

Once a Kafka instance is in use, it will be saved in configuration and used with commands like topics etc..

wtrocki · 2021-01-25T14:44:13Z

@craicoverflow In some cases I have pointed issues on docs and some cases in the code. Sorry for confusion. Generally all things are suggestions (subjective opinion from outsider person).

Checked locally. Printouts looks good!

Enda Phelan added 2 commits January 25, 2021 14:08

docs: improve help text in commands

99a7ce8

chore(docs): generate reference documentation

8c5a07f

wtrocki approved these changes Jan 25, 2021

View reviewed changes

wtrocki reviewed Jan 25, 2021

View reviewed changes

pkg/cmd/kafka/describe/describe.go Show resolved Hide resolved

wtrocki reviewed Jan 25, 2021

View reviewed changes

Enda Phelan added 4 commits January 25, 2021 15:15

docs: update cluster commands

bbb8c92

fix: replace "currently selected" with "current"

b6e8f09

chore: remove backend impl detail context

44f79da

chore: update topics text

6a78eef

craicoverflow merged commit e8dce46 into main Jan 25, 2021

craicoverflow deleted the help-text branch January 25, 2021 16:05

craicoverflow linked an issue Jan 28, 2021 that may be closed by this pull request

Review In-CLI help text #258

Closed


		Pass the –id flag to specify which instance you would like to view.

		If the –id flag is not passed then the selected Kafka instance will be

	Your web browser will open automatically where you can securely enter
	Your web browser will open a new tab automatically where you can securely enter

	Reset the SASL/PLAIN credentials for a service account.
	Reset the service credentials for a service account.

	Once a Kafka instance is in use, it becomes the "current" instance.
	Once a Kafka instance is in use, it will be saved in configuration and used with commands like topics etc..

Conversation

craicoverflow commented Jan 25, 2021

Uh oh!

wtrocki commented Jan 25, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

craicoverflow commented Jan 25, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

craicoverflow Jan 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wtrocki commented Jan 25, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

craicoverflow Jan 25, 2021 •

edited

Loading