zlux icon indicating copy to clipboard operation
zlux copied to clipboard

Clarification needed for JES explorer hover help text

Open jrnewton opened this issue 1 year ago • 10 comments

Describe the bug The hover help for the JCL "EXPORT" statement contains an unfamiliar technical term 🤣

The text:

EXPORT 
Operation Field Smack it

Steps to Reproduce

  1. Open JES explorer
  2. Open a Job
  3. Open a JESJCL member containing EXPORT
  4. Hover over EXPORT

Screenshots (if needed)

2023-05-19 07_06_26-zowe - T-4135-169-59-184-241 ibmztrialmachines com - Remote Desktop Connection

Describe your environment Using Zowe version 2.2.0+20220714 via the Z Trials program

jrnewton avatar May 19 '23 11:05 jrnewton

wow! thanks for reporting that. i'm assuming this hasnt changed in a while and i see it here https://github.com/zowe/explorer-wlp-packaging/blob/e637435ee0794c893efdc442315d2485b608f503/src/main/resources/languages/orion/jcl.json#L26 so i'll discuss it on the team meeting in 15 minutes

1000TurquoisePogs avatar May 19 '23 12:05 1000TurquoisePogs

Looking at that file, it also seems we could add some better hover help text in many fields...

1000TurquoisePogs avatar May 19 '23 12:05 1000TurquoisePogs

Perhaps the https://www.ibm.com/docs/en/zos/2.4.0?topic=reference-export-statement JCL reference is a good source of more meaningful text

1000TurquoisePogs avatar May 19 '23 12:05 1000TurquoisePogs

Is there a non-archived repo that contains the hover help text? I'd love to submit a PR but had no clue where it was defined.

jrnewton avatar May 23 '23 02:05 jrnewton

I just unarchived https://github.com/zowe/explorer-wlp-packaging because I figure it probably is in there, but when I install explorer-jes locally, and grep around, I don't see the text, so I'm not sure how we're getting it in there. @AdarshdeepCheema are you aware of how this gets pulled in?

Regarding contribution one way or another, it's best to make a fork on github and then a PR from that fork, so it probably doesnt matter if something's archived or not.

1000TurquoisePogs avatar Jun 02 '23 15:06 1000TurquoisePogs

Spoke too soon, I was just greping wrong:

/sgrady/explorer-jes/node_modules> rg --no-ignore "Smack"
orion-editor-component/dist/utilities/jcl.js
41:            EXPORT: 'Operation Field Smack it',

orion-editor-component/src/utilities/jcl.js
36:            EXPORT: 'Operation Field Smack it',

1000TurquoisePogs avatar Jun 02 '23 15:06 1000TurquoisePogs

So... it's actually THIS repo: https://github.com/zowe/orion-editor-component/blob/736bf5763baf4c6966f9e1ef835f4fc994a82f39/src/utilities/jcl.js#L36

1000TurquoisePogs avatar Jun 02 '23 15:06 1000TurquoisePogs

I just unarchived https://github.com/zowe/explorer-wlp-packaging because I figure it probably is in there, but when I install explorer-jes locally, and grep around, I don't see the text, so I'm not sure how we're getting it in there. @AdarshdeepCheema are you aware of how this gets pulled in?

Regarding contribution one way or another, it's best to make a fork on github and then a PR from that fork, so it probably doesnt matter if something's archived or not.

No idea :( , I think it was discussed in the past as well. and when we tried but could not find the source

AdarshdeepCheema avatar Jun 02 '23 18:06 AdarshdeepCheema

Thanks for the PR! It looks good to me so I approved it, but considering the age of that repo I need to figure out how it attaches to the overall build so we can get it in the production build. Now that I learned about that list of hoverhelp, I'm wondering if we can even add more interesting help there, a few of the strings dont say much.

1000TurquoisePogs avatar Jun 09 '23 16:06 1000TurquoisePogs

That auto-closed. Going to keep open until I know its in the build. Having an issue with the build automation, so checking on that.

1000TurquoisePogs avatar Jun 09 '23 19:06 1000TurquoisePogs