Skip to content

doc for ZRS binary on PATH#5095

Open
anaxceron wants to merge 5 commits into
docs-stagingfrom
anax-v3.6-zowex-executable-ze
Open

doc for ZRS binary on PATH#5095
anaxceron wants to merge 5 commits into
docs-stagingfrom
anax-v3.6-zowex-executable-ze

Conversation

@anaxceron

Copy link
Copy Markdown
Collaborator

Describe your pull request here: Adding doc on how to add ZRS binary to your PATH

List the file(s) included in this PR:

  • docs\getting-started\ze-configuring-zowe-remote-ssh.md
  • sidebars.js

After creating the PR, follow the instructions in the comments.

Signed-off-by: anaxceron <ana.ceron@broadcom.com>
@anaxceron
anaxceron requested a review from CBforZ July 20, 2026 14:24
@anaxceron anaxceron self-assigned this Jul 20, 2026
@anaxceron anaxceron added area: zowe-explorer Issues related to the VSC extension Zowe Explorer release: V3 Zowe V3 content review: sme Needs review by an SME labels Jul 20, 2026
@github-actions

Copy link
Copy Markdown

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these steps.

  • Add the label review: sme if an SME needs to check your content.
  • Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
  • Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
    • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
  • Link any Doc Issues related to this PR.
  • Fix broken links found in your content areas.
  • Notify the SME to review this PR (if applicable).
  • Merge to the master branch if your PR updates content that is on the live site. Merge to docs-staging if your PR updates content for a future release.

@anaxceron
anaxceron marked this pull request as draft July 20, 2026 14:25
@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown

@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 14:32 Inactive
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
@anaxceron
anaxceron marked this pull request as ready for review July 22, 2026 19:10
@github-actions
github-actions Bot temporarily deployed to pull request July 22, 2026 19:15 Inactive
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Editing the JSON file
#### Editing the VS Code Configuration JSON file

Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md Outdated

@traeok traeok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this Ana! I'm requesting changes around a missing verb, and I left a suggestion around ordering for the new sections.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence "The path..." is missing a verb

Suggested change
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@traeok traeok Jul 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I'm in favor of moving it after the "Configuration methods" section, but open to other ideas 😋

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@traeok @CBforZ - Shifted some things around in an effort to add context earlier on about when/why a user would want to pursue the $PATH stuff. Lmk if that works or not.

@github-project-automation github-project-automation Bot moved this from New Issues to Review/QA in Zowe Explorer for VS Code Jul 23, 2026
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
@github-actions
github-actions Bot temporarily deployed to pull request July 23, 2026 14:05 Inactive
Comment thread docs/getting-started/ze-configuring-zowe-remote-ssh.md
@CBforZ
CBforZ requested a review from MarkAckert July 23, 2026 18:35
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
@github-actions
github-actions Bot temporarily deployed to pull request July 24, 2026 18:17 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: zowe-explorer Issues related to the VSC extension Zowe Explorer release: V3 Zowe V3 content review: sme Needs review by an SME

Projects

Status: Review/QA

Development

Successfully merging this pull request may close these issues.

4 participants