zowe-cli
zowe-cli copied to clipboard
Append URLs to the long descriptions so that we can connect the CLI help pages to related online doc sources such as Zowe doc and Doc Ops
Goal: Append URLs to the long descriptions so that we can connect the CLI help pages to related online doc sources such as Zowe doc and Doc Ops. These could include URLs to documentation and URLs to related information. The CLI help is an island relative to the many other resources that are available. URLs are the bridge to those resources. This feature request is related to #411 .
Overarching problem: Improving the Findability and Discoverability of Capabilities and Functionality. We hear customers explain that they can't find what they are looking for. Also they don't understand the capabilities of the CLI so we need better ways to reveal that information.
Specific examples
- URLs to difficult concepts like
- Option precedence and the various ways to set options like profiles, and environmental variables. We've seen users struggle with this specific example.
- z/OSMF configuration
- Sub-system support, such as Db2 and CICS.
- Security issues
- Logging
- Extending the CLI
- URLs to Doc Ops troubleshooting
- URLs to the CLI Reference document
- URLs to best practices
- URLs to examples, use cases, scripts, etc.
- URLs to webinars and other videos
- People will need to copy and paste the URLs.