Skip to content
This repository has been archived by the owner on Nov 13, 2023. It is now read-only.

Documentation contains wrong samples #728

Closed
zszabo14 opened this issue Jan 27, 2022 · 5 comments · Fixed by #729 or zowe/docs-site#2018
Closed

Documentation contains wrong samples #728

zszabo14 opened this issue Jan 27, 2022 · 5 comments · Fixed by #729 or zowe/docs-site#2018
Assignees
Labels
bug Something isn't working

Comments

@zszabo14
Copy link

Hi

I've just seen the documentation was updated. I found that the samples are wrong for some commands, like

https://docs.zowe.org/stable/web_help/index.html?p=zowe_zos-files_copy_data-set

the sample commands referring to rse-api-for-zowe-cli.

zowe **rse-api-for-zowe-cli** copy data-set "USER.FROM.SET" "USER.TO.SET"

@MikeBauerCA
Copy link

@zszabo14 thank you very much for reporting. +@awharn could you please review this issue as soon as possible?

@zszabo14
Copy link
Author

Maybe you can also add a new category for the command list like:

- Standard
- zos-console | console - Issue z/OS console commands and collect responses
- zos-files | files - Manage z/OS data sets
- zos-ftp | zftp - z/OS Files and jobs via FTP
- zos-jobs | jobs - Manage z/OS jobs
- zos-logs | logs - Interact with z/OS logs
- zos-ssh | ssh | zos-uss | uss - Issue z/OS USS commands and receive responses
- zos-tso | tso - Interact with TSO
- zos-workflows | wf - Create and manage z/OSMF workflows
- zosconnect - z/OS Connect EE plugin for Zowe CLI
- zosmf - Interact with z/OSMF

- IBM
- mq
- DB2

- CA
- endevor - CA Endevor SCM plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
- endevor-bridge-for-git | ebg - Interact with a CA Endevor Bridge for Git server
file-master-plus | fmp - Advanced file management and data manipulation
- idms - Interact with CA IDMS

- NetView

@awharn
Copy link
Member

awharn commented Jan 27, 2022

@MikeBauerCA We've discovered that there is a bug in Imperative that, in certain situations where the name, handler path, and description of two commands are identical, the web-help might display the information for the wrong command. Since the web-help generator is removing the handler paths to protect the information of contributors, we've run into a situation where the name and description are the same. I'm working on a fix, and should have a PR open shortly.

Since the issue has been identified in Imperative, I'm transferring the issue over to that repository.

@awharn awharn transferred this issue from zowe/zowe-cli Jan 27, 2022
@awharn awharn self-assigned this Jan 27, 2022
@awharn awharn added the bug Something isn't working label Jan 27, 2022
@MikeBauerCA
Copy link

Thanks, just to follow-up on the second request @zszabo14 - we do not currently intend to split the commands by organization. However, if you are only interested in a specific area, you could try to leverage the search bar in the upper left under Tree View or Flat View to limit results. If I may ask, why would you like to see commands split into sections based on which organization owns the plug-in? This information is also available on our conformance site.

@JamesBauman
Copy link

To complete issue #728.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
4 participants