Azure / service-catalog-cli

See the upstream repository ->
https://github.com/kubernetes-incubator/service-catalog
MIT License
33 stars 14 forks source link

Can we clarify the intent of the CLI (wrapper vs usability)? #20

Closed carolynvs closed 6 years ago

carolynvs commented 6 years ago

I asked this originally #18 and am moving my question into a separate issue to not derail the PR.

Do we expect an aks/acs users to immediately understand what "relist" means? Or should we expect our command naming and help text to occasionally provide more user-friendly terms that abstract API implementation details? (disclosure: I fall into the latter camp)

As a k8s person, and service catalog newb, I find svc-cat broker sync <name> a better indicator of what the command is going to do. The verb "relist" seems to expose the underlying implementation details of how we trigger updating the cached broker metadata.

I'm wondering if this CLI is intended to be a pure wrapper for the API, matching term for term, request for request, without abstraction or adjustments for an improved user experience? Often the user-base and expected learning curve for using an API and CLI are not exactly the same.

arschles commented 6 years ago

@carolynvs good questions.

RE svc-cat broker sync, I'm good with that naming. We can always add an alias later for relist

Regarding pure wrapper vs. abstraction - this tool should be an abstraction to improve user experience. The basic get/list commands are just the start, and broker sync is the next step after that.

arschles commented 6 years ago

@carolynvs can we close this?

carolynvs commented 6 years ago

Yup!