Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the readme with better instructions and swift development. #307

Merged
merged 7 commits into from
Aug 16, 2024
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,17 @@ On z/OS, git 2.14.4 is the minimum needed.
### Runtime
To use the App Server, the following is required:

* **NodeJS** - v16.x up to v18.x is officially supported by the Zowe community.
## Node Version Setup for Zowe on Windows

### Choosing the Right Node Version
For setting up Zowe, it's recommended to install Node 16.x. Although Zowe supports up to Node 18, Node 16.x is more stable and tends to work better without errors.

### Installing Node on Windows
Avoid using `nvm` for updating Node versions on Windows as it can cause bugs. Instead, delete your current version and install the exact version from the [Node.js official website](https://nodejs.org/).
Copy link
Member

Choose a reason for hiding this comment

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

It can? like what?

Copy link
Member

Choose a reason for hiding this comment

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

It's the "Common nvm errors on Windows" area below @1000TurquoisePogs

@Atharva-Kanherkar Let's bridge these two sections together, they don't need their own. Also I would prefer some of these to be "Notes"

Copy link
Author

Choose a reason for hiding this comment

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

Okay sure, would you like these to be notes under the node version or under the whole readme?


### Common `nvm` Errors on Windows
Using `nvm` on Windows might result in errors like "Can't find the module ncp". It's better to avoid using `nvm` to prevent these issues.
Copy link
Member

Choose a reason for hiding this comment

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

Sounds like a bug we should fix rather than telling people not to use nvm

Copy link
Author

Choose a reason for hiding this comment

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

Yes, I agree, but there were some problems troubleshooting, so can we keep it until we solve the bug? Or should i remove it?



Plugins may depend upon other technologies, such as Java or ZSS. A plugin's [pluginDefinition](https://docs.zowe.org/stable/extend/extend-desktop/mvd-plugindefandstruct) or README will help you to understand if additional prerequisites are needed for that plugin.

Expand Down Expand Up @@ -147,10 +157,35 @@ If you encounter an error message saying `No config file found, initializing`, i

To fix this issue, you need to create a zowe.yaml file in the following directory: `%USERPROFILE%\.zowe\workspace\app-server\serverConfig`. You can use [this](https://github.com/zowe/zlux-app-server/blob/v2.x/staging/defaults/serverConfig/defaults.yaml) template as a starting point.

### Fixing Build Errors

If you encounter an "Invalid tag name" error or issues at the package level when installing dependencies, the error may lie with poor package-lock metadata. To resolve this:
- Reset the `package-lock.json` by running `git checkout package-lock.json` to remove any changes made prior.
- If the install step still fails, try removing the `package-lock.json` entirely.


### Customizing Configurations and Server Errors

#### Validating YAML Configuration
Ensure your `zowe.yaml` file is valid YAML. Use any online YAML checker to validate your file. Proper configuration is crucial for the system to function correctly. Please refer the information covered in [Section 7](#7-adding-zss-to-the-environment) to configure your file correctly.

#### Handling Unhandled Rejection Errors
**Known Issue & Workaround:** If you get an error stating `Unhandled rejection, Type error: Cannot read properties of undefined` after attempting to start your App Server, the issue is most likely with your configuration. Due to some highly customized configuration settings, if there is no easily identifiable cause, you can revert to a less strict version of the App Server via these two commands:
Copy link
Member

Choose a reason for hiding this comment

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

This is a known issue? Where is the ticket describing it?
This reads more like

Problem: there is some bug
Workaround: reset everything

How about we learn more about this bug and try to fix it

Copy link
Member

Choose a reason for hiding this comment

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

@Atharva-Kanherkar Make a ticket for this using the Zlux repo's "Issues" page. Lmk if you need help filling out any fields

@1000TurquoisePogs the fix for this we are unsure, how long will take. I played around with it for half a day, without success so it won't be trivial. We have multiple start-up/configuratio nrelated bugs. But I'll have them look into it

Copy link
Author

Choose a reason for hiding this comment

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

On it!


zlux-server-framework:
```
git checkout 7a394212bb13af24b587ea22f3c7267981d31111
```
zlux-app-server:
```
git checkout d112621faf9d86862ed458e5244732479bf7fbf3
```

### Server Logs
When the server starts, it writes logs to a text file. On z/OS, Unix, and Linux, the server also logs to the terminal via stdout.
To view the entire logs, you can find the log file within the location specified by the zowe server configuration parameter `zowe.logDirectory`, but will default to `~/.zowe/logs` or `%USERPROFILE%/.zowe/logs` (Windows) if not specified. The log file starts with "appServer" and the filename may also include a timestamp.


## 4. Connect in a browser
With the App Server started, you can access Apps and the Zowe Desktop from it in a web browser.
In this example, the address you will want to go to first is the location of the window management App - Zowe Desktop.
Expand Down Expand Up @@ -379,6 +414,11 @@ components:
ipAddresses:
- 0.0.0.0
keyring: "/path/to/keystore.p12"





password: "keyringpassword"
label: "keylabel"
dataserviceAuthentication:
Expand Down