From 3258e8474767404a37d09d5d5b8e9421095fc7e7 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Fri, 20 Sep 2024 15:31:00 +0200 Subject: [PATCH 1/2] minor language refactor Signed-off-by: Andrew Jandacek --- docs/user-guide/sdks-using.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/user-guide/sdks-using.md b/docs/user-guide/sdks-using.md index 766a00f73b..ca8d710253 100644 --- a/docs/user-guide/sdks-using.md +++ b/docs/user-guide/sdks-using.md @@ -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 @@ -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 @@ -56,7 +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` as in the following code extract: ``` @@ -66,23 +66,24 @@ For a Maven project add the SDK as a dependency by updating your `pom.xml` as fo ``` -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` as in the following code extract: ``` 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 ` - *where* `` is the name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`. + * `` + 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. @@ -94,11 +95,12 @@ 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 ` - *where* `` is the name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`. + * `` + 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). @@ -118,12 +120,13 @@ 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: `npm install .tgz` - To install a Python package: `pip install .whl` - *where* `` is the name of the package that you want to install, such as `zos-files-for-zowe-sdk`. + * `` + 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. @@ -133,7 +136,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. @@ -155,7 +158,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. From 35afa0cab7ae6b00f33fb6ce681d77eaf7302e25 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Mon, 23 Sep 2024 12:15:48 +0200 Subject: [PATCH 2/2] minor language edits Signed-off-by: Andrew Jandacek --- docs/user-guide/sdks-using.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/sdks-using.md b/docs/user-guide/sdks-using.md index ca8d710253..60f3f7f5f3 100644 --- a/docs/user-guide/sdks-using.md +++ b/docs/user-guide/sdks-using.md @@ -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 in the following code extract: - +For a Maven project, add the SDK as a dependency by updating your `pom.xml`: ``` org.zowe.client.java.sdk @@ -66,7 +65,7 @@ For a Maven project, add the SDK as a dependency by updating your `pom.xml` as i ``` -For a Gradle project add the SDK as a dependency by updating your `build.gradle` as in the following code extract: +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' @@ -97,7 +96,8 @@ Pull the packages from an online registry such as PyPi. 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 ` + - To import a Python package, use the following syntax: + `pip install ` * `` The name of the SDK package that you want to install, such as `zos-files-for-zowe-sdk`. @@ -122,8 +122,11 @@ Download and install the packages. 4. In a command-line window, navigate to your project directory. Issue *one* of the following commands: - - To install a Node.js package: `npm install .tgz` - - To install a Python package: `pip install .whl` + - To install a Node.js package, use the following syntax: + `npm install .tgz` + + - To install a Python package, use the following syntax: + `pip install .whl` * `` The name of the package that you want to install, such as `zos-files-for-zowe-sdk`.