doc for ZRS binary on PATH#5095
Conversation
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these steps.
|
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
| The `zowex` binary is now set in your VS Code settings and the custom server path is used to deploy ZRS when you connect to that host. | ||
| #### Editing the JSON file |
There was a problem hiding this comment.
| #### Editing the JSON file | |
| #### Editing the VS Code Configuration JSON file |
| 1. In the **Command Palette**, search for **Zowe Explorer: Connect to zowex server on host...**. | ||
| 1. In the **Command Palette**, search for **Zowe-SSH: Connect to Host...**. | ||
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. |
There was a problem hiding this comment.
Sentence "The path..." is missing a verb
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. | |
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path is saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. |
| 1. In the **Command Palette**, search for **Zowe-SSH: Connect to Host...**. | ||
| 1. In the **Command Palette**, search for **Zowe Explorer: Connect to zowex server on host...**. | ||
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. |
There was a problem hiding this comment.
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. | |
| If you have not yet configured a server path, you are prompted for a path to deploy the server. The path is saved in the `zowe.zowex.serverInstallPath` key in the VS Code `settings.json` file. |
| - z/OS OpenSSH set up and configured for the user | ||
| - At minimum, user permissions for read, write, and execute (`700`) for deployment directory | ||
|
|
||
| ## Adding ZRS to your `$PATH` |
There was a problem hiding this comment.
I noticed this section was inserted before ## Configuration methods, which is what explains how/where the zowex binary gets deployed. Step 2 mentions to point $PATH at the "directory where the zowex binary was deployed," which may confuse a reader if they are deploying their own instance (and not a shared one).
Thoughts on moving this section after "Configuration methods" or adding an explicit line about the deploy path being defined?
There was a problem hiding this comment.
Happy to relocate this to where it makes the most sense OR to add some context and not relocate content. Looking for the team to provide direction on this.
There was a problem hiding this comment.
Personally, I'm in favor of moving it after the "Configuration methods" section, but open to other ideas 😋
There was a problem hiding this comment.
Not 100% sure about before or after, since part of the point of the $PATH detection feature is for Zowe Explorer to find an instance of zowex on the $PATH if it has been deployed outside of Zowe Explorer (like manually extracting a pax file, or it was deployed in the past and the config for the server path was somehow deleted, we could detect it automatically on the $PATH).
If we put this after the sections about auto-deploying with Zowe Explorer, then folks might trigger an auto deploy first, then realize they should follow instructions for using a shared instance based on their site setup .
Maybe we can keep it where it is and further clarify the context of how zowex might be deployed? Like that you would add it to your $PATH before using Zowe Explorer to connect if you know you have a shared instance, and otherwise allow VS Code to deploy it
There was a problem hiding this comment.
That's fair, plus I don't want that section to get glossed/skipped over either by being further down in the article. I think as long as we provide some clarity or use cases for why a user would pursue adding to PATH, they know to skip over the section if these pre-requisites do not apply to them
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
Describe your pull request here: Adding doc on how to add ZRS binary to your PATH
List the file(s) included in this PR:
After creating the PR, follow the instructions in the comments.