From f2ef92ca2f7a63c9eef75e9dfc9b34b42c0c4e2a Mon Sep 17 00:00:00 2001 From: anaxceron Date: Fri, 15 Nov 2024 14:05:48 -0500 Subject: [PATCH] reworked draft per squad feedback Signed-off-by: anaxceron --- docs/whats-new/release-notes/v3_0_0.md | 22 -------------- ....md => zowe-compatibility-statement-v3.md} | 10 +++++-- sidebars.js | 2 +- .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../zowe-compatibility-statement-v2.md | 29 +++++++++++++++++++ .../version-v2.15.x-sidebars.json | 1 + .../version-v2.16.x-sidebars.json | 1 + .../version-v2.17.x-sidebars.json | 1 + .../version-v2.18.x-sidebars.json | 1 + 11 files changed, 128 insertions(+), 26 deletions(-) rename docs/whats-new/{zowe-compatibility-statement.md => zowe-compatibility-statement-v3.md} (74%) create mode 100644 versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md create mode 100644 versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md diff --git a/docs/whats-new/release-notes/v3_0_0.md b/docs/whats-new/release-notes/v3_0_0.md index 6c98afa05d..c9c21ac365 100644 --- a/docs/whats-new/release-notes/v3_0_0.md +++ b/docs/whats-new/release-notes/v3_0_0.md @@ -232,25 +232,3 @@ For a complete list of enhancements and bug fixes, see the following changelogs: - [IBM Db2 Databse Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-db2-plugin/blob/master/CHANGELOG.md) - [IBM z/OS FTP Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-ftp-plugin/blob/master/CHANGELOG.md) - [IBM MQ Plug-in Zowe CLI](https://github.com/zowe/zowe-cli-mq-plugin/blob/master/CHANGELOG.md) - -## Conformance and release compatibility - -### Backward compatibility - -Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. - -**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. - -### Forward compatibility - -Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. - -**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. - -### Conformance compatibility - -Zowe V2 conformant extensions/plug-ins are likely to require changes to meet Zowe V3 conformance criteria. All extensions (regardless of V2 conformance status) must apply for V3 conformance and satisfy all required V3 testing criteria. You can find the V3 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). - -**Recommendation:** All extenders interested in earning V3 conformance review the V3 conformance criteria, determine if technical changes are necessary, make appropriate modifications and prepare to apply for V3 conformance. - -**Need help?** For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the `#zowe-onboarding` channel. diff --git a/docs/whats-new/zowe-compatibility-statement.md b/docs/whats-new/zowe-compatibility-statement-v3.md similarity index 74% rename from docs/whats-new/zowe-compatibility-statement.md rename to docs/whats-new/zowe-compatibility-statement-v3.md index bcaa7943b1..87e5b86c78 100644 --- a/docs/whats-new/zowe-compatibility-statement.md +++ b/docs/whats-new/zowe-compatibility-statement-v3.md @@ -4,13 +4,17 @@ Zowe V2 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V3 and therefore may not be operable. In general, plug-ins/extensions which leverage V3 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. -**Recommendation:** All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation +All V2 extenders test with Zowe V3, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: ## Forward compatibility Zowe V3 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V2 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V2 functions are at minimum risk. -**Recommendation:** All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +:::tip Recommendation +All V3 extenders test with Zowe V2 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: ## Conformance compatibility @@ -22,4 +26,4 @@ All extenders interested in earning V3 conformance review the V3 conformance cri ## Need help? -For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the `#zowe-onboarding` channel. \ No newline at end of file +For assistance with reviewing or completing the Zowe Conformance Zowe V3 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/sidebars.js b/sidebars.js index 6b1b598ad6..aaad3e4a69 100644 --- a/sidebars.js +++ b/sidebars.js @@ -41,7 +41,6 @@ module.exports = { "whats-new/release-notes/v2_0_0", ], }, - "whats-new/zowe-compatibility-statement", ], "getting-started": [ { @@ -106,6 +105,7 @@ module.exports = { }, ], }, + "whats-new/zowe-compatibility-statement-v3", "getting-started/cli-getting-started", ], "setup": [ diff --git a/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.15.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.16.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.17.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md b/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md new file mode 100644 index 0000000000..29a848f747 --- /dev/null +++ b/versioned_docs/version-v2.18.x/whats-new/zowe-compatibility-statement-v2.md @@ -0,0 +1,29 @@ +# Zowe conformance and release compatibility + +## Backward compatibility + +Zowe V1 conformant extensions/plug-ins are not guaranteed to be compatible with Zowe V2 and therefore may not be operable. In general, plug-ins/extensions which leverage V2 APIs that have known breaking changes are at high risk of incompatibility and unpredictable results. + +:::tip Recommendation +All V1 extenders test with Zowe V2, identify any issues, and disclose results to consumers to clearly indicate backward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Forward compatibility + +Zowe V2 conformant (planning to earn conformance) extensions/plug-ins are not guaranteed to be compatible with Zowe V1 LTS. In general, plug-ins/extensions with no known dependency on any newly introduced Zowe V1 functions are at minimum risk. + +:::tip Recommendation +All V2 extenders test with Zowe V1 LTS, identify any issues, and disclose results to consumers to clearly indicate forward compatibility status in the extension documentation. If unable to test, clearly document as such. +::: + +## Conformance compatibility + +Zowe V1 conformant extensions/plug-ins are likely to require changes to meet Zowe V2 conformance criteria. All extensions (regardless of V1 conformance status) must apply for V2 conformance and satisfy all required V2 testing criteria. You can find the V2 Conformance Criteria [here](https://github.com/openmainframeproject/foundation/files/8489757/Zowe.Conformance.Program.-.Test.Evaluation.Guide.Table.pdf). + +:::tip Recommendation +All extenders interested in earning V2 conformance review the V2 conformance criteria, determine if technical changes are necessary, make appropriate modifications, and prepare to apply for V2 conformance. +::: + +## Need help? + +For assistance with reviewing or completing the Zowe Conformance Zowe V2 application, reach out to members of the Zowe Onboarding Squad on Slack at https://slack.openmainframeproject.org in the **#zowe-onboarding** channel. diff --git a/versioned_sidebars/version-v2.15.x-sidebars.json b/versioned_sidebars/version-v2.15.x-sidebars.json index 6dba58eaa8..7e32875c2f 100644 --- a/versioned_sidebars/version-v2.15.x-sidebars.json +++ b/versioned_sidebars/version-v2.15.x-sidebars.json @@ -108,6 +108,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.16.x-sidebars.json b/versioned_sidebars/version-v2.16.x-sidebars.json index cdff456095..dc6ee7d552 100644 --- a/versioned_sidebars/version-v2.16.x-sidebars.json +++ b/versioned_sidebars/version-v2.16.x-sidebars.json @@ -109,6 +109,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.17.x-sidebars.json b/versioned_sidebars/version-v2.17.x-sidebars.json index 2996581ea8..9aa06a6076 100644 --- a/versioned_sidebars/version-v2.17.x-sidebars.json +++ b/versioned_sidebars/version-v2.17.x-sidebars.json @@ -112,6 +112,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources", diff --git a/versioned_sidebars/version-v2.18.x-sidebars.json b/versioned_sidebars/version-v2.18.x-sidebars.json index 268a0626df..fef86e4c45 100644 --- a/versioned_sidebars/version-v2.18.x-sidebars.json +++ b/versioned_sidebars/version-v2.18.x-sidebars.json @@ -113,6 +113,7 @@ "className": "ToCitemcolor", "id": "extend/migrate-extensions" }, + "whats-new/zowe-compatibility-statement-v2", { "type": "doc", "label": "Zowe learning resources",