From 3d97200fe103f373bb75776c2e5971e8dd84e7bc Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 25 Oct 2023 13:21:32 +0200 Subject: [PATCH 1/5] Update Zowe Doc Squad - 23PI4 Objectives.md Signed-off-by: Andrew Jandacek --- .../Zowe Doc Squad - 23PI4 Objectives.md | 46 ++++--------------- 1 file changed, 10 insertions(+), 36 deletions(-) diff --git a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md index 160c08c63..b61c0e3b0 100644 --- a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md +++ b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md @@ -1,5 +1,5 @@ # Zowe Doc Squad - 23PI4 Pre-PI Plan -(October 2023 January 2024) +(October 2023 - January 2024) ## Completion of improvements to server-side installation documentation @@ -10,32 +10,19 @@ * Creation of scenario-based articles by installation method: Document four linear, co-located installations scenarios by method Tasks to complete these objectives: - -* Complete draft of article Address Security Requirements - * Consolidate all security configuration articles withing this Security Requirements section - * Include diagram showing the full security ecosystem + * Draft an article 'Troubleshooting installation and configuration' with links to common solution procedures. Add links in the installation ariticles to this Troubleshooting guide. -* Add real-world examples to the various installation procedures +* Add real-world examples to the various installation procedures. (Many of these examples can be provided with links to existing video content) * For each installation method, add outcome of individual steps. (Criteria defined in Issue [#2963](https://github.com/zowe/docs-site/issues/2963)). -## Reorganize Configuration topics: +## Document tips on server install verification ([#2092](https://github.com/zowe/docs-site/issues/3092)) -* Configuring Zowe z/OS Components -* Configuring certificates -* Configuring High Availability +Directions of what to look for in output logs and in the browser to determine what server configuration is correct and operational. Specifically, this relates to the zwe init command group and subcommands (several of which require security admin permissions to run properly). -Tasks: -Reorganize the sidebar to follow the full sequence to configure z/OS Components (and include links to next steps in the configuration process): -(Create parent articles for the 2 options to initalize Zowe z/OS runtime. Ensure consistent article naming from the installation checklist to the article that outlines the procedure.) - - **Configure z/OS Componenents Sequence** - 1. Use one of the following options to initialize Zowe z/OS runtime. - * Option 1: Initialize Zowe maunally using zwe init command group - * Option 2: Configure Zowe with z/OSMF workflows - 3. Configure the z/OS system for Zowe - 4. Grant users permission to access z/OSMF - 5. Install and configure the Zowe cross memory server (ZWESISTC) +## Document the upgrade path between minor versions ([#2714](https://github.com/zowe/docs-site/issues/2714)) + +Users occasionally run into problems when upgrading the zowe versions. Prepare a page which would explain how you migrate from lower to higher versions, with one page per major version. ## V3 prep work (target release date: March 28, 2024) @@ -54,27 +41,14 @@ Objective: Determine how best to communicate important changes (deprecations, el ## Doc repo issues - Continue to work on addressing and closing Doc repo issues -## Stretch Objectives - -### Zowe issue triaging/handling guide (stretch) -- Develop the Issue Triaging/Handling Guide to help contributors understand the criteria and process for triaging and assigning issues across repos. ([TSC Issue](https://github.com/zowe/community/blob/master/Technical-Steering-Committee/issues.md#issues)) - -### Validation of certificate configuration documentation (stretch) - - **Tasks:** - * Perform a review of [Zowe secure setup and configuration](https://docs.zowe.org/stable/getting-started/zowe-secure-setup/). - * Draft a chapter for Security Configuration in the user-guide section. - * Include validation steps where possible. - ## Videos Goal: Educate users through engaging content format - videos. -Create scenario-based demo videos for Zowe certificate configuration. +Create video and associated blog post for Zowe certificate configuration scenario 2 (linking to scenario 2) +* Use a file-based (PKCS12) keystore and import a certificate generated by another CA -Create scenario-based demo videos for Zowe security configuration. -Create demo videos for Zowe extensions. * ## Dependencies From 7059f82cf069ed03c5adfd77276de9c59dbf3bf1 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 25 Oct 2023 13:28:10 +0200 Subject: [PATCH 2/5] Update Zowe Doc Squad - 23PI4 Objectives.md Signed-off-by: Andrew Jandacek --- .../Zowe Doc Squad - 23PI4 Objectives.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md index b61c0e3b0..f971d67da 100644 --- a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md +++ b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md @@ -18,7 +18,7 @@ Tasks to complete these objectives: ## Document tips on server install verification ([#2092](https://github.com/zowe/docs-site/issues/3092)) -Directions of what to look for in output logs and in the browser to determine what server configuration is correct and operational. Specifically, this relates to the zwe init command group and subcommands (several of which require security admin permissions to run properly). +Provide directions of what to look for in output logs and in the browser to determine what server configuration is correct and operational. Specifically, this relates to the `zwe init` command group and subcommands (several of which require security admin permissions to run properly). ## Document the upgrade path between minor versions ([#2714](https://github.com/zowe/docs-site/issues/2714)) @@ -27,12 +27,11 @@ Users occasionally run into problems when upgrading the zowe versions. Prepare a ## V3 prep work (target release date: March 28, 2024) - Continue to develop and execute a doc strategy for Zowe V3 content - - Assign specific content to individual writers to shepherd through the V2-V3 upgrade process - Review content with squads, SMEs to determine scope of needed changes for V3 documentation - - Begin V3 documentation + - Draft V3 documentation where needed ## Consumer Awareness Section(s) -Objective: Determine how best to communicate important changes (deprecations, eliminations or new introductions) to the Zowe technology that may have an impact on Zowe Consumers (and Extenders). This may be in the form of a general section that links to embedded alerts near the related / applicable technical documentation or something else. +Determine how best to communicate important changes (deprecations, eliminations or new introductions) to the Zowe technology that may have an impact on Zowe Consumers (and Extenders). This may be in the form of a general section that links to embedded alerts near the related / applicable technical documentation or something else. ## CII Badge standards From 0c5e17d1880ea6d2fe417316c6022e605fb6f9ad Mon Sep 17 00:00:00 2001 From: Adam Wolfe <122040687+adam-wolfe@users.noreply.github.com> Date: Wed, 25 Oct 2023 07:39:48 -0400 Subject: [PATCH 3/5] Update Zowe CLI Squad - 23PI4 Objectives.md Signed-off-by: Adam Wolfe <122040687+adam-wolfe@users.noreply.github.com> --- .../Zowe CLI Squad - 23PI4 Objectives.md | 26 +++++++++---------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe CLI Squad - 23PI4 Objectives.md b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe CLI Squad - 23PI4 Objectives.md index 383148432..1a1074b1a 100644 --- a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe CLI Squad - 23PI4 Objectives.md +++ b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe CLI Squad - 23PI4 Objectives.md @@ -10,25 +10,23 @@ Implement planned changes for V3 and publish a pre-release version to npm. - [ ] [v3: Remove "bright" command #1792](https://github.com/zowe/zowe-cli/issues/1792) - [ ] [Standardize use of capitalization and punctuation in command descriptions #1756](https://github.com/zowe/zowe-cli/issues/1756) - [ ] [Support logging in to multiple APIML instances per config file #1705](https://github.com/zowe/zowe-cli/issues/1705) +- [ ] [Document v3 team config changes #1801](https://github.com/zowe/zowe-cli/issues/1801) - [ ] [Stretch] [v3: Consistent --editor option across CLI commands that can open editor imperative#992](https://github.com/zowe/imperative/issues/992) +## High Priority Defects and Enhancements +- [ ] [`files edit` commands should support binary and encoding options #1725](https://github.com/zowe/zowe-cli/issues/1725) +- [ ] [Regression-7.4.1 : download data-set-matching option -d does not preserve upper case #1722](https://github.com/zowe/zowe-cli/issues/1722) + ## SDK Conformance and LTS status Work with the Onboarding Squad and the IntelliJ Explorer Squad to develop Zowe client SDK conformance criteria and ensure that the Node.JS and Python Zowe Client SDKs achieve conformance. - [ ] [Zowe SDK - Update SDK conformance documentation #1676](https://github.com/zowe/zowe-cli/issues/1676) - [ ] [Zowe SDK - Develop and publish sample Node.js SDK #1675](https://github.com/zowe/zowe-cli/issues/1675) -## Address Items in the CLI and Imperative Backlogs -Take action in accordance with Community Guidelines to support Zowe CLI users and extenders, resolve defects, and implement beneficial enhancements suggested by members of the Zowe community. - -CLI Squad Plan: -#### *Enhancements* -- [ ] None planned - -#### *Bugs* -- [ ] [Stretch] [Regression-7.4.1 : download data-set-matching option -d does not preserve upper case](https://github.com/zowe/zowe-cli/issues/1722) -- [ ] [Stretch] [zowe auth login examples are incorrect](https://github.com/zowe/imperative/issues/998) -- [ ] [Stretch] [Add instructions to enable prompting for any option](https://github.com/zowe/zowe-cli/issues/1741) -- [ ] [Stretch] [zowe plugins list registry qualification](https://github.com/zowe/zowe-cli/issues/63) +## Review and Enhance System Tests +- Perform an inventory of existing system tests. +- Identify gaps in testing. What functionality is not covered that should be? +- Implement additional system tests where gaps exist. +- Identify opportunities to use community computing resources. ## OpenSSF Best Practices Badge This work may carry across 23PI3 and 23PI4: @@ -54,7 +52,7 @@ This work may carry across 23PI3 and 23PI4: - New Programming languages (like Kotlin SDK) - Prepare the SDKs technically and logistically for conformance - Apply for (and achieve) conformance for existing SDKs - - Release the SDKs as LTS + - Release the Node.js SDK as LTS with the eventual goal of also achieving LTS for the Python SDK - _When do you plan to start the work?_ - **CY23Q2** - _When do you plan to deliver the solution?_ @@ -68,7 +66,7 @@ This work may carry across 23PI3 and 23PI4: - _When do you plan to start the work?_ - **CY22Q3** - _When do you plan to deliver the solution?_ - - **CY22Q4** (delayed until **TBD**) + - **CY22Q4** (delayed until CY24Q1) ## (Done) Keytar Replacement - _What problem are you solving?_ From 0ab45117d8fb0a45c1594987401be3448a2d60e7 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 25 Oct 2023 13:44:37 +0200 Subject: [PATCH 4/5] Update Zowe Doc Squad - 23PI4 Objectives.md Signed-off-by: Andrew Jandacek --- .../Zowe Doc Squad - 23PI4 Objectives.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md index f971d67da..c30f7c3dc 100644 --- a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md +++ b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md @@ -20,6 +20,9 @@ Tasks to complete these objectives: Provide directions of what to look for in output logs and in the browser to determine what server configuration is correct and operational. Specifically, this relates to the `zwe init` command group and subcommands (several of which require security admin permissions to run properly). +## Create Scenario-Based Article to Customize API ML ([#2967](https://github.com/zowe/docs-site/issues/2967)) +Restructure the Advanced server-side configuration for API Mediaiton Layer to organize these config options by component. Articles should establish when and why the config is executed, and by whom. + ## Document the upgrade path between minor versions ([#2714](https://github.com/zowe/docs-site/issues/2714)) Users occasionally run into problems when upgrading the zowe versions. Prepare a page which would explain how you migrate from lower to higher versions, with one page per major version. From 3d5d8e364c1e0dbdf1e0257baf6308e35e60428e Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 25 Oct 2023 13:48:08 +0200 Subject: [PATCH 5/5] Update Zowe Doc Squad - 23PI4 Objectives.md Signed-off-by: Andrew Jandacek --- .../Zowe Doc Squad - 23PI4 Objectives.md | 40 +------------------ 1 file changed, 2 insertions(+), 38 deletions(-) diff --git a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md index c30f7c3dc..4be787d86 100644 --- a/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md +++ b/Project Management/PI Planning/23PI4 Planning/PI Planning Preparation by Squad/Zowe Doc Squad - 23PI4 Objectives.md @@ -51,51 +51,15 @@ Create video and associated blog post for Zowe certificate configuration scenari * Use a file-based (PKCS12) keystore and import a certificate generated by another CA - * ## Dependencies -- Dependency on API ML squad and other contributors to finish the improvement in install and config documentation on doc site +- Dependency on API ML squad and other contributors to assist with the Customize API ML section - Dependency on SMEs, squads to help review needed content upgrades for Zowe V3 - Dependency on Zowe CLI, Zowe Explorer squads to update documentation for CII Badge standards. - * Dependency on demo video input contributors. - * Dependency on the developers who are involved with the legacy issues in doc site repository. -## 23PI3 Accomplishments - -- Created Role-Based Zowe Prereq Articles - Under a parent topic entitled 'Prepare for Installation' (formerly 'System requirements') define the specifc role(s) responsible behind these child topics: - * Address z/OS Requirements - * Address Security Requirements - * Address USS Requirements - * Address node.js Requirements - * Address Storage Requirements - * Address Network Requirements - * Address Browser Requirements - - This enhancement request comes directly from user feedback received during the Spring 2023 Zowe Server Installation Study. (Criteria defined in Issue [#2962](https://github.com/zowe/docs-site/issues/2962)). - -- Improved server-side installation documentation based on user feedback - -- Create scenario-based articles by installation method: - Document four linear, co-located installations scenarios by method: - * Install Zowe via z/OSMF (from PSWI & SMP/E Workflow) - * Install Zowe via SMP/E - * Install Zowe via Convenience Build - * Install Zowe via Container - - (Criteria defined in Issue [#2960](https://github.com/zowe/docs-site/issues/2960)) - -- Create a detailed Zowe installation overview article. - Elements in this overview to include: - * End-to-end install/config flow diagram - * Roles & Responsibilities - * Zowe Key Terms & Concepts: Zowe runtime, Zowe Application Framework, Zowe API Mediation Layer, Z Secure Services (ZSS), Zowe Cross Memory Server - * Technology Needs: YAML, node.js, USS background details - * Install Methods Explained - - (Criteria defined in Issue [#2961](https://github.com/zowe/docs-site/issues/2961)). +