api-layer icon indicating copy to clipboard operation
api-layer copied to clipboard

Published 20 hours ago • verified publisher icon zowe

Rename the enablers to SDKs

Open taban03 opened this issue 3 years ago • 5 comments

Based on a feedback from Dan Kelosky on the Wizard:

"On the dropdown itself, could your team consider alternative wording? Most folks outside of Zowe team don't seem understand what an "enabler" is, nor which one they should choose. It seems to be an internally understood term, not a generic one. Perhaps the drop down could ask what language on runtime the API is using and help users discover what "enabler" they are using?"

So, it would mean to:

  1. Rename all occurrences of the "enabler" word (Wizard, modules, Zowe doc) to a different word (maybe it could be "Onboarding methods" or "Onboarding ways")
  2. Add enhancement in the Wizard to help the user to discover the right enabler. (question whether it would be helpful)

https://github.com/zowe/api-layer/wiki/Issue-management

taban03 avatar Feb 17 '22 15:02 taban03

@dkelosky here is the issue Dan, feel free to add more context in case

taban03 avatar Feb 22 '22 15:02 taban03

Thanks @taban03 - the title of the doc for the wizard is "Onboarding a REST API service with YAML Wizard", and the wizard has a helpful button to Onboard New API: image

In both cases, the user knows they need to onboard an API; however, once you try to onboard your API, suddenly you're presented with a list of "enabler"s. I'm not clear if "enabler" is a universal term in industry, but I don't think it is. It seems to be [internal?] terminology that is tied to our APIML. Even folks that know Eureka may only know of a "Eureka Client" - not an "enabler".

Perhaps it's just my opinion, but I think it would be ideal to continue to guide users by letting them answer questions they're going to know, that is their API type:

  • Spring
  • NodeJs
  • etc...

From there they could be guided through static or dynamic registration. The dynamic registration could help them determine if they have an "enabler" or otherwise help them use one.

dkelosky avatar Mar 02 '22 14:03 dkelosky

Great suggestion!

@taban03 i wonder if this is something we can add to the scope of the mentee work on the wizard?

jalel01 avatar Mar 04 '22 15:03 jalel01

Great suggestion!

@taban03 i wonder if this is something we can add to the scope of the mentee work on the wizard?

@jalel01 Yes, I think this might be a good candidate for mentee work as part of the Wizard enhancement.

taban03 avatar Mar 05 '22 14:03 taban03

The actual proposal for solving this is to name the Enablers as SDK. This is a common approach, and on top of that, it's approach that is already used in other owe areas. We have SDKs for the CLI related functionality and the SDK like this brings the similar approach to the Server side.

balhar-jakub avatar Sep 13 '22 09:09 balhar-jakub