search

zowe / zowe-cli

Zowe CLI
Eclipse Public License 2.0
113 stars 87 forks source link

Clarify use cases and/or examples for Zowe SDKs #2192

Open traeok opened 2 months ago

traeok commented 2 months ago

Is your feature or enhancement request related to a problem or limitation? Please describe

Some of the Zowe SDK examples, namely the z/OS Files SDK, use the ProfileInfo facility to read a configuration file from disk. This is recommended and often suitable for desktop apps, plug-ins and extenders. However, developers trying to use the SDKs in a web environment may encounter issues related to I/O or secure credential access when using ProfileInfo.

Describe your enhancement idea

Update the existing examples, or add new ones to show how the SDKs could be used in a web environment (such as, without the use of ProfileInfo). We could also add a brief list of use cases to help direct users to the appropriate examples for their projects.

Describe alternatives you've considered

We can recommend, on a case-by-case basis, to not use ProfileInfo in web-based environments. However, adding this to the documentation could help resolve any confusion when using a Zowe SDK for the first time.

github-actions[bot] commented 3 weeks ago

Thank you for raising this enhancement request. The community has 90 days to vote on it. If the enhancement receives at least 5 upvotes, it is added to our development backlog. If it receives fewer votes, the issue is closed.