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

Address issue #3851 #3886

Merged
merged 2 commits into from
Sep 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions docs/user-guide/sdks-using.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following SDKs are available:

- Zowe Java Client SDK
- Zowe Node.js Client SDK
- Zowe Python Client SDK
- Zowe Client Python SDK

## SDK documentation

Expand All @@ -20,13 +20,13 @@ For detailed SDK documentation, see the following:

### Java SDK

Requires Java runtime version 11 and above.
Requires Java runtime version 11 and later versions.

### Node.js SDK

If you install Node SDK packages from the online registry, the required dependencies are installed automatically.

If you download Node SDK packages from Zowe.org, the folder contains dependencies that you must install manually. Extract the TGZ files from the folder, copy the files to your project, and issue the following commands to install the dependencies.
If you download Node SDK packages from Zowe.org, the folder contains dependencies that you must install manually. Extract the TGZ files from the folder, copy the files to your project, and issue the following commands to install the dependencies:

```
npm install imperative.tgz
Expand Down Expand Up @@ -56,8 +56,7 @@ To install this library in your project, use a build tool such as Maven, Gradle

https://mvnrepository.com/artifact/org.zowe.client.java.sdk/zowe-client-java-sdk

For a Maven project add the SDK as a dependency by updating your `pom.xml` as follows:

For a Maven project, add the SDK as a dependency by updating your `pom.xml`:
```
<dependency>
<groupId>org.zowe.client.java.sdk</groupId>
Expand All @@ -66,23 +65,24 @@ For a Maven project add the SDK as a dependency by updating your `pom.xml` as fo
</dependency>
```

For a Gradle project add the SDK as a dependency by updating your `build.gradle` as follows:
For a Gradle project, add the SDK as a dependency by updating your `build.gradle`:

```
implementation group: 'org.zowe.client.java.sdk', name: 'zowe-client-java-sdk', version: '2.2.0'
```

The version 2.2.0 can change. Look at the artifact link to select latest version.
The version 2.2.0 can change. Look at the artifact link to select the latest version.

### Install Node.js from an online registry

Pull the packages from an online registry such as npm.

1. In command-line window, navigate to your project directory. Issue the following command to install a package from the registry:
1. In the command-line window, navigate to your project directory. Issue the following command to install a package from the registry:

- To import a Node.js package: `npm install <PackageName>`

*where* `<packageName>` is the name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`.
* `<packageName>`
The name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`.

The packages are installed. Node packages are defined in `package.json` in your project.

Expand All @@ -94,11 +94,13 @@ Pull the packages from an online registry such as npm.

Pull the packages from an online registry such as PyPi.

1. In command-line window, navigate to your project directory. Issue the following command to install a package from the registry:
1. In the command-line window, navigate to your project directory. Issue the following command to install a package from the registry:

- To import a Python package: `pip install <PackageName>`
- To import a Python package, use the following syntax:
`pip install <PackageName>`

*where* `<packageName>` is the name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`.
* `<packageName>`
The name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`.

Python packages are installed by default to `$PYTHONPATH/Lib/site-packages` (Linux) or to the Python folder in your local `/AppData` folder (Windows).

Expand All @@ -118,12 +120,16 @@ Download and install the packages.

3. Install required dependencies, which are included in the bundle. See [Software requirements](#software-requirements) above for more information.

4. In a command-line window, navigate to your project directory. Issue *one* of the following commands.
4. In a command-line window, navigate to your project directory. Issue *one* of the following commands:

- To install a Node.js package, use the following syntax:
`npm install <packageName>.tgz`

- To install a Node.js package: `npm install <packageName>.tgz`
- To install a Python package: `pip install <packageName>.whl`
- To install a Python package, use the following syntax:
`pip install <packageName>.whl`

*where* `<packageName>` is the name of the package that you want to install, such as `zos-files-for-zowe-sdk`.
* `<packageName>`
The name of the package that you want to install, such as `zos-files-for-zowe-sdk`.

Repeat the command for each package that you need. Packages are now installed.

Expand All @@ -133,7 +139,7 @@ After you install the SDK, you can make API calls to the mainframe from within y

### Using - Java

For Java SDK usage and syntax examples, refer to the following package readmes:
For Java SDK usage and syntax examples, refer to the following package READMEs:

- [Team Config](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/teamconfig/README.md) - Read only team configuration operations.
- [z/OS Console](https://github.com/zowe/zowe-client-java-sdk/blob/main/src/main/java/zowe/client/sdk/zosconsole/README.md) - Perform z/OS console operations.
Expand All @@ -155,7 +161,7 @@ https://github.com/Zowe-Java-SDK

### Using - Node.js

For Node SDK usage and syntax examples, refer to the following package Readmes:
For Node SDK usage and syntax examples, refer to the following package READMEs:

- [Core libraries](https://www.npmjs.com/package/@zowe/core-for-zowe-sdk) - Use shared libraries, such as `rest` to access z/OSMF REST APIs, `auth` for connecting to token-based authentication services, and more.
- [z/OS Console](https://www.npmjs.com/package/@zowe/zos-console-for-zowe-sdk) - Perform z/OS console operations.
Expand Down
Loading