Skip to content

Commit

Permalink
reworked draft per squad feedback
Browse files Browse the repository at this point in the history
Signed-off-by: anaxceron <[email protected]>
  • Loading branch information
anaxceron committed Nov 15, 2024
1 parent 186d047 commit f2ef92c
Show file tree
Hide file tree
Showing 11 changed files with 128 additions and 26 deletions.
22 changes: 0 additions & 22 deletions docs/whats-new/release-notes/v3_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
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.
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ module.exports = {
"whats-new/release-notes/v2_0_0",
],
},
"whats-new/zowe-compatibility-statement",
],
"getting-started": [
{
Expand Down Expand Up @@ -106,6 +105,7 @@ module.exports = {
},
],
},
"whats-new/zowe-compatibility-statement-v3",
"getting-started/cli-getting-started",
],
"setup": [
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions versioned_sidebars/version-v2.15.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@
"className": "ToCitemcolor",
"id": "extend/migrate-extensions"
},
"whats-new/zowe-compatibility-statement-v2",
{
"type": "doc",
"label": "Zowe learning resources",
Expand Down
1 change: 1 addition & 0 deletions versioned_sidebars/version-v2.16.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
"className": "ToCitemcolor",
"id": "extend/migrate-extensions"
},
"whats-new/zowe-compatibility-statement-v2",
{
"type": "doc",
"label": "Zowe learning resources",
Expand Down
1 change: 1 addition & 0 deletions versioned_sidebars/version-v2.17.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
"className": "ToCitemcolor",
"id": "extend/migrate-extensions"
},
"whats-new/zowe-compatibility-statement-v2",
{
"type": "doc",
"label": "Zowe learning resources",
Expand Down
1 change: 1 addition & 0 deletions versioned_sidebars/version-v2.18.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
"className": "ToCitemcolor",
"id": "extend/migrate-extensions"
},
"whats-new/zowe-compatibility-statement-v2",
{
"type": "doc",
"label": "Zowe learning resources",
Expand Down

0 comments on commit f2ef92c

Please sign in to comment.