From 25041858b71364ec157574ddcc57a5533e852be6 Mon Sep 17 00:00:00 2001 From: Adam Wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:30:45 -0500 Subject: [PATCH 01/10] Update ZE API README.md Signed-off-by: Adam Wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index 754a79de4f..529552ab5a 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,11 +5,9 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -The current state of this API is experimental, but the goal is provide a stabilized version that can be used for Zowe Conformance certifications in the future. See this issue for more details: . +Extensibility API for Zowe Explorer is used by several open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as a several commercial extensions. -However, the current API is being used by other extensions already, such as for Zowe Explorer with the [Zowe Explorer FTP Extension](../zowe-explorer-ftp-extension) that you can find in this same Git repository, as well as for commercial extensions maintained by Zowe's contributors and available on their company websites. - -Currently, the API is organized into two modules, which both are rolled up into the top-level `index.ts` file for convenient access. +Currently, the API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. - `/profiles`: Provides access to common Zowe CLI profile management APIs, as well as abstractions for providing alternative z/OS interactions that use protocols other than z/OSMF, based on alternative Zowe CLI profile types. - `/tree`: Provides abstractions for accessing and extending the Zowe Explorer VS Code tree views. From 123124153f1494c298d3a5ef382b7c00ea68a805 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:36:17 -0500 Subject: [PATCH 02/10] Remove "currently" Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index 529552ab5a..c5bd04848a 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -7,7 +7,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to Extensibility API for Zowe Explorer is used by several open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as a several commercial extensions. -Currently, the API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. +The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. - `/profiles`: Provides access to common Zowe CLI profile management APIs, as well as abstractions for providing alternative z/OS interactions that use protocols other than z/OSMF, based on alternative Zowe CLI profile types. - `/tree`: Provides abstractions for accessing and extending the Zowe Explorer VS Code tree views. From 379aa2ab806edd3134eeeeddc79815b927960ec6 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:41:54 -0500 Subject: [PATCH 03/10] Avoid overuse of "several" Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index c5bd04848a..65738d26b5 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,7 +5,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -Extensibility API for Zowe Explorer is used by several open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as a several commercial extensions. +Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as a several commercial extensions. The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. From 0d1e3393b77862d827c9a5be5f1177b03f907a54 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 09:58:32 -0500 Subject: [PATCH 04/10] Remove V3 pre-release note and add tip for insert key Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/zowe-explorer/README.md b/packages/zowe-explorer/README.md index 0492a4746b..b968736665 100644 --- a/packages/zowe-explorer/README.md +++ b/packages/zowe-explorer/README.md @@ -5,8 +5,6 @@ [![codecov](https://codecov.io/gh/zowe/zowe-explorer-vscode/branch/main/graph/badge.svg)](https://codecov.io/gh/zowe/zowe-explorer-vscode) [![slack](https://img.shields.io/badge/chat-on%20Slack-blue)](https://slack.openmainframeproject.org/) -> ## v3 Pre-release is now available in our [Github Releases](https://github.com/zowe/zowe-explorer-vscode/releases) with the removal of v1 profile support. Keep an eye on [changes affecting users and extenders](https://github.com/zowe/zowe-explorer-vscode/wiki/v3-Changes-for-Users-and-Extenders) for the full list of changes - ## Introduction [Zowe Explorer](https://github.com/zowe/community#zowe-explorer) is a sub-project of Zowe, focusing on modernizing the mainframe experience. [Zowe](https://www.zowe.org/) is a project hosted by the [Open Mainframe Project](https://www.openmainframeproject.org/), a [Linux Foundation](https://www.linuxfoundation.org/) project. @@ -156,6 +154,8 @@ Your token has been successfully invalidated. - **Open recent members**: Zowe Explorer lets you open a list of members you worked on earlier. You can access the list by pressing `Ctrl`+`Alt`+`R` (Windows) or `Command`+`Option`+`R` (Mac). +- **Insert/overtype mode**: Visual Studio Code v1.96 introduced the ability to toggle between insert and overtype mode by pressing the `Insert` key. Overtype mode can be helpful when working with data sets and members with fixed record lengths. + For the comprehensive Zowe Explorer documentation that also includes information about USS and Jobs interactions, see [the Zowe Explorer documentation](https://docs.zowe.org/stable/user-guide/ze-install.html) in Zowe Docs. ## Keyboard Shortcuts From a33977a7ccaa2146984f16141912d79b94f74a16 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 13:51:36 -0500 Subject: [PATCH 05/10] Fixed typo Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index 65738d26b5..f152548b89 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,7 +5,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as a several commercial extensions. +Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. From 09bb653ba646fafb89fcd061d7b93aeac8404fec Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 15:27:08 -0500 Subject: [PATCH 06/10] modes Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/zowe-explorer/README.md b/packages/zowe-explorer/README.md index b968736665..0436ad1256 100644 --- a/packages/zowe-explorer/README.md +++ b/packages/zowe-explorer/README.md @@ -154,7 +154,7 @@ Your token has been successfully invalidated. - **Open recent members**: Zowe Explorer lets you open a list of members you worked on earlier. You can access the list by pressing `Ctrl`+`Alt`+`R` (Windows) or `Command`+`Option`+`R` (Mac). -- **Insert/overtype mode**: Visual Studio Code v1.96 introduced the ability to toggle between insert and overtype mode by pressing the `Insert` key. Overtype mode can be helpful when working with data sets and members with fixed record lengths. +- **Insert/overtype modes**: Visual Studio Code v1.96 introduced the ability to toggle between insert and overtype modes by pressing the `Insert` key. Overtype mode can be helpful when working with data sets and members with fixed record lengths. For the comprehensive Zowe Explorer documentation that also includes information about USS and Jobs interactions, see [the Zowe Explorer documentation](https://docs.zowe.org/stable/user-guide/ze-install.html) in Zowe Docs. From 1374f9e8986e28ea8dd193b9b7a45faa1e2f1888 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 18 Dec 2024 16:18:58 -0500 Subject: [PATCH 07/10] adjust links for npmjs Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index f152548b89..af7b243edd 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,7 +5,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](../zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. +Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. @@ -21,9 +21,9 @@ The `/profiles` module has no dependency to VS Code and could be used in Zowe CL import { ZoweExplorerApi } from "@zowe/zowe-explorer-api/lib/profiles"; ``` -The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpApi.ts](../zowe-explorer-ftp-extension/src/ZoweExplorerFtpApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](./src/profiles/ZoweExplorerZosmfApi.ts) +The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts](/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](/packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts) -Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](../zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain +Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](/packages/zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain ```json "extensionDependencies": [ @@ -51,4 +51,4 @@ See this [special extension document](https://github.com/zowe/zowe-explorer-vsco Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/zowe-explorer-vscode). You find the sources there in the `/packages/zowe-explorer-api` sub-folder. -To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues) after reviewing the [API Roadmap item](https://github.com/zowe/zowe-explorer-vscode/issues/837). +To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues). From b90e67b20a302dbe45602de70be549b20e722603 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Thu, 19 Dec 2024 14:04:41 -0500 Subject: [PATCH 08/10] Full URL to FTP extension Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index af7b243edd..b3e8017b53 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,7 +5,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. +Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. From a4af76881ac1c7f4e3539490527647a034661add Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Thu, 19 Dec 2024 14:26:52 -0500 Subject: [PATCH 09/10] Some addl wording changes Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index b3e8017b53..3142a32526 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -5,7 +5,7 @@ Extensibility API for Zowe Explorer is a collection of APIs that can be used to extend the [Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode) VS Code extension with alternative z/OS interaction protocols and new capabilities. -Extensibility API for Zowe Explorer is used by open source Zowe Explorer extensions, including the [IBM z/OS FTP for Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. +The API is used by extenders of the Zowe Explorer VS Code extension, including the [IBM z/OS FTP for Zowe Explorer](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension) and [IBM CICS for Zowe Explorer](https://github.com/zowe/cics-for-zowe-client/tree/main/packages/vsce) VS Code extensions, as well as several commercial extensions. The API is organized into modules that are exposed through the top-level `index.ts` file for convenient access. @@ -51,4 +51,4 @@ See this [special extension document](https://github.com/zowe/zowe-explorer-vsco Extensibility API for Zowe Explorer is part of the [Zowe Explorer monorepo on Github](https://github.com/zowe/zowe-explorer-vscode). You find the sources there in the `/packages/zowe-explorer-api` sub-folder. -To file issues, use the [Zowe Explorer issue list](https://github.com/zowe/zowe-explorer-vscode/issues). +To submit a bug report or enhancement request, open an issue in the [Zowe Explorer repository](https://github.com/zowe/zowe-explorer-vscode/issues). From 9d2fe2c07047bf91b5bce905006757b9a80f4e79 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Fri, 20 Dec 2024 10:10:49 -0500 Subject: [PATCH 10/10] Replace all relative paths with full URLs Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- packages/zowe-explorer-api/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/zowe-explorer-api/README.md b/packages/zowe-explorer-api/README.md index 3142a32526..1604ec6032 100644 --- a/packages/zowe-explorer-api/README.md +++ b/packages/zowe-explorer-api/README.md @@ -21,9 +21,9 @@ The `/profiles` module has no dependency to VS Code and could be used in Zowe CL import { ZoweExplorerApi } from "@zowe/zowe-explorer-api/lib/profiles"; ``` -The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts](/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](/packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts) +The main API provided by the `/profiles` module is called `ZoweExplorerApi`. It defines a namespace for interfaces for implementing access to z/OS MVS, USS, and JES. You can see that the Zowe Explorer FTP Extension provides such an alternative implementation for USS using the FTP protocol in [packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpMvsApi.ts). The `/profiles` module itself contains Zowe Explorer's default implementation using z/OSMF in [packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts) -Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](/packages/zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain +Zowe Explorer itself exports a `IApiRegisterClient` object that can be used for an alternative implementation to be registered with Zowe Explorer. You can find an example for doing this in [packages/zowe-explorer-ftp-extension/src/extension.ts](https://github.com/zowe/zowe-explorer-vscode/tree/main/packages/zowe-explorer-ftp-extension/src/extension.ts). To be able to do this, your VS Code extension must define a dependency to Zowe Explorer to ensure that VS Code extension activation is performed in the correct order. Therefore, your VS Code extension's `package.json` must contain ```json "extensionDependencies": [