From f8f50ff634d12d5fe6734036eae00d062fc4ba62 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Thu, 30 May 2024 08:54:54 -0400 Subject: [PATCH 1/4] Add link to CLI/SDK breaking changes Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- _data/vnext_changes.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/vnext_changes.yml b/_data/vnext_changes.yml index 0af01ede..c267bff6 100644 --- a/_data/vnext_changes.yml +++ b/_data/vnext_changes.yml @@ -33,7 +33,7 @@ - Update Webpack to version 5 - Update Typescript to 4.9 -- name: CLI +- name: CLI & Client Node.js SDKs homepage_link: /#zowe-cli-intro image: /assets/img/zowe-cli.webp description: | @@ -42,7 +42,7 @@ - Introduce new format for error messages to improve clarity - Remove V1 profile support - - Remove deprecated items - [CLI](https://github.com/zowe/zowe-cli/issues/1694) and [Imperative](https://github.com/zowe/imperative/issues/970) + - A comprehensive list of breaking changes made to Zowe CLI and the Zowe Client Node.js SDKs is available [here](https://ibm.ent.box.com/s/vqu92d82b4wk0i6fupo8glbrxvufn4zw) **Pre-release availability** From cafcf19f0dd05f3fafe3a8fe15eed397fcc526e0 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Thu, 30 May 2024 09:20:14 -0400 Subject: [PATCH 2/4] A few grammar fixes Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- _data/vnext_faq.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_data/vnext_faq.yml b/_data/vnext_faq.yml index daf62841..996c124b 100644 --- a/_data/vnext_faq.yml +++ b/_data/vnext_faq.yml @@ -1,6 +1,6 @@ general: - number: 1 - question: When will be Zowe V3 available for testing? + question: When will Zowe V3 be available for testing? answer: | The current plan is to have Zowe V3 for all projects available as preview by the December 2023 @@ -22,7 +22,7 @@ extenders: We intend to move the configuration for V3 to the currently used gateway configuration space e.g. zowe.components.gateway therefore the configuration that was Zuul specific will be removed and the one that is Spring Cloud Gateway will be added to this space. - number: 3 - question: How the client certificate authentication will work? + question: How will the client certificate authentication work? answer: | The northbound authentication works by accepting the client certificates. The API Mediation Layer then transforms the client certificate to another method of authentication such as JWT token or SAF IDT or passtickets and these needs to be accepted by the southbound services. @@ -41,7 +41,7 @@ extenders: The bypass scheme remains and you still can claim conformance for services that provides only public endpoints that doesn't require authentication. - number: 6 - question: Does the dependency changes mean that I need Java 17 to run Zowe + question: Do the dependency changes mean that I need Java 17 to run Zowe answer: | Yes @@ -84,7 +84,7 @@ extenders: It's possible for the Desktop extensions to bring in different versions of React as the desktop is compatible with React but not built on top of React. - number: 4 - question: Is ZEN application running on desktop or on z/OS? + question: Is the ZEN application running on desktop or on z/OS? answer: | ZEN is running on laptop/desktop and connects to z/OS via standard methods. @@ -108,7 +108,7 @@ extenders: It's different topic and it's not linked other than by sharing the zwe commands. - number: 8 - question: Does the App Store for Zowe handles Zowe upgrades? + question: Does the App Store for Zowe handle Zowe upgrades? answer: | No, it's focused on the server side extensions. @@ -133,7 +133,7 @@ consumers: The API ML in version 3 supports clients with onboarding enablers from version 2. It also works the other way around the onboarding enablers from version 3 will continue working with Zowe v2 - number: 2 - question: For us, as for extenders, jump to Java 17 means that we have to maintain 2 separate versions of our application - one with apiml-enabler v2 and another one with v3 to support customers who want to stay with Java 8. Do you have any recommendation or a workaround how to support both java versions? + question: For us, as for extenders, the jump to Java 17 means that we have to maintain 2 separate versions of our application - one with apiml-enabler v2 and another one with v3 to support customers who want to stay with Java 8. Do you have any recommendation or a workaround how to support both java versions? answer: | Plain Java Enabler in v2 will work in v3 - you can keep this for 1 - 2 years From 044aa8050ac6df6502bf9d895f2b4aa88391830f Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Thu, 30 May 2024 16:47:44 -0400 Subject: [PATCH 3/4] Changes per Ana's feedback Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- _data/vnext_changes.yml | 3 ++- _data/vnext_faq.yml | 26 +++++++++++++------------- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/_data/vnext_changes.yml b/_data/vnext_changes.yml index c267bff6..3b5425d3 100644 --- a/_data/vnext_changes.yml +++ b/_data/vnext_changes.yml @@ -42,7 +42,8 @@ - Introduce new format for error messages to improve clarity - Remove V1 profile support - - A comprehensive list of breaking changes made to Zowe CLI and the Zowe Client Node.js SDKs is available [here](https://ibm.ent.box.com/s/vqu92d82b4wk0i6fupo8glbrxvufn4zw) + + A comprehensive list of breaking changes made to Zowe CLI and the Zowe Client Node.js SDKs in V3 is available [here](https://ibm.ent.box.com/s/vqu92d82b4wk0i6fupo8glbrxvufn4zw). **Pre-release availability** diff --git a/_data/vnext_faq.yml b/_data/vnext_faq.yml index 996c124b..2fd3f960 100644 --- a/_data/vnext_faq.yml +++ b/_data/vnext_faq.yml @@ -22,7 +22,7 @@ extenders: We intend to move the configuration for V3 to the currently used gateway configuration space e.g. zowe.components.gateway therefore the configuration that was Zuul specific will be removed and the one that is Spring Cloud Gateway will be added to this space. - number: 3 - question: How will the client certificate authentication work? + question: How does the client certificate authentication work in Zowe V3? answer: | The northbound authentication works by accepting the client certificates. The API Mediation Layer then transforms the client certificate to another method of authentication such as JWT token or SAF IDT or passtickets and these needs to be accepted by the southbound services. @@ -41,17 +41,17 @@ extenders: The bypass scheme remains and you still can claim conformance for services that provides only public endpoints that doesn't require authentication. - number: 6 - question: Do the dependency changes mean that I need Java 17 to run Zowe + question: Do the dependency changes mean that I need Java 17 to run Zowe? answer: | - Yes + Yes. Java 17 is required to run the API Mediation Layer in Zowe V3. - name: Zowe Explorers for VSCode Office Hours id: questions-explorers questions: - number: 1 - question: Will the functionality to convert profiles from profiles to Team Config remain available for V3 + question: Will the functionality to convert profiles from profiles to Team Config remain available for V3? answer: | Yes, unlike the support for the V1 profiles. @@ -69,7 +69,7 @@ extenders: question: Is it possible to have side by side 32 bits plugin to ZSS with 64 bits ones? answer: | - No, it's not possible right now. It's possible to run just one type of plugins as there is the possibility to run only one ZSS. + No, it is not possible right now. It is possible to run just one type of plugins as there is the possibility to run only one ZSS. - number: 2 question: Are the libraries updated to the currently latest versions? @@ -81,7 +81,7 @@ extenders: question: What React versions are supported? answer: | - It's possible for the Desktop extensions to bring in different versions of React as the desktop is compatible with React but not built on top of React. + It is possible for the Desktop extensions to bring in different versions of React as the desktop is compatible with React but not built on top of React. - number: 4 question: Is the ZEN application running on desktop or on z/OS? @@ -90,7 +90,7 @@ extenders: ZEN is running on laptop/desktop and connects to z/OS via standard methods. - number: 5 - question: Is is possible to validate and change the zowe.yaml and job definition within the ZEN? + question: Is it possible to validate and change the zowe.yaml and job definition within the ZEN? answer: | Yes @@ -99,19 +99,19 @@ extenders: question: What happens if in ZEN you click on the SMP/E? answer: | - You will be guided through the different set of pages that relates to the SMP/E installation + You will be guided through the different set of pages that relate to the SMP/E installation. - number: 7 - question: What's the intersection between Zowe Store and ZEN? + question: What is the connection between Zowe Store and ZEN? answer: | - It's different topic and it's not linked other than by sharing the zwe commands. + It is a different topic and it is not linked other than by sharing the zwe commands. - number: 8 question: Does the App Store for Zowe handle Zowe upgrades? answer: | - No, it's focused on the server side extensions. + No, it is focused on the server side extensions. - name: Zowe System Installation and Configuration Office Hours id: questions-zowe-systems @@ -133,7 +133,7 @@ consumers: The API ML in version 3 supports clients with onboarding enablers from version 2. It also works the other way around the onboarding enablers from version 3 will continue working with Zowe v2 - number: 2 - question: For us, as for extenders, the jump to Java 17 means that we have to maintain 2 separate versions of our application - one with apiml-enabler v2 and another one with v3 to support customers who want to stay with Java 8. Do you have any recommendation or a workaround how to support both java versions? + question: For us, as for extenders, the jump to Java 17 means that we have to maintain two separate versions of our application - one with apiml-enabler v2 and another one with v3 to support customers who want to stay with Java 8. Do you have a recommendation or a workaround for supporting both java versions? answer: | Plain Java Enabler in v2 will work in v3 - you can keep this for 1 - 2 years @@ -144,7 +144,7 @@ consumers: question: Can you speak about the migration from Zuul to Spring Cloud Gateway? Today there are two separate gateway services in API-ML with separate config. answer: | - Goal is to have 1, spring-cloud gateway. The spring-cloud-gateway configuration should move under the component.gateway namespace. We expect to have one cluster od spring cloud gateway ahead of multiple sysplexes and then one cluster on every sysplex. Most of the configuration that was used should remain, new one from Spring Cloud Gateway remains. + The goal is to have one: spring-cloud gateway. The spring-cloud-gateway configuration should move under the component.gateway namespace. We expect to have one cluster od spring cloud gateway ahead of multiple sysplexes and then one cluster on every sysplex. Most of the configuration that was used should remain, new one from Spring Cloud Gateway remains. - number: 4 question: If you have a legacy gateway deployed will there be migration help? / is the old gateway gone? From 5f976d9a07ccbaf4830af54bff30f37ae9bed990 Mon Sep 17 00:00:00 2001 From: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Fri, 28 Jun 2024 14:59:00 -0400 Subject: [PATCH 4/4] Add link to ZE for VSC breaking change doc Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com> --- _data/vnext_changes.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_data/vnext_changes.yml b/_data/vnext_changes.yml index 3b5425d3..0efb1bc3 100644 --- a/_data/vnext_changes.yml +++ b/_data/vnext_changes.yml @@ -71,9 +71,10 @@ - Remove V1 profile support - Remove deprecated items - [Explorer for VSCode](https://github.com/zowe/zowe-explorer-vscode/issues/2238) - - Change profile creation menus - Store extension settings in the local storage + A comprehensive list of breaking changes made to Zowe Explorer for VS Code in V3 is available [here](https://ibm.box.com/s/exray2epor6eh61ygvpe6urp3xb30rld). + **Important updates** - Store persistent settings in local storage