(Doc) 1.21.0 Regular doc update #1604
Conversation
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
There was a problem hiding this comment.
Thanks @IgorCATech for putting this together! I made a couple suggestions to the Readme, which can also be applied to the Changelog.
Additionally, I think we can add items for some of the other PRs we merged since the last release (including for the ZE FTP extension). Please check my reply to your squad message for more details on this request. Thanks again!
packages/zowe-explorer/README.md
Outdated
|
|
||
| **Fixed**: | ||
|
|
||
| - Fixed the Not Found issue that resulted from attempts to delete a member whose parent data set was already deleted using multi-delete. | ||
| - Fixed the issue that caused JCL errors in the JOBS tree to be displayed as `undefined:undefined(undefined)` | ||
| - Fixed the Theia input box issue |
There was a problem hiding this comment.
@IgorCATech We might want to add a bit more description here to describe what issue with Theia input boxes was fixed, especially since items are listed here without their associated PRs.
Maybe something like: "Fixed the Theia input box issue that caused entered values to be incorrectly validated."
packages/zowe-explorer/README.md
Outdated
|
|
||
| **Added**: | ||
|
|
||
| - Added a Github action bot that automates the issue triage. | ||
| - Add a progress bar for the simultaneous deletion of multiple jobs |
There was a problem hiding this comment.
Actually, we use the Past tense for such notes in this doc. You can check the previously added notes
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
| ## `1.21.0` | ||
|
|
||
| - Added unit tests for the FTP USS functionality [#1582](https://github.com/zowe/vscode-extension-for-zowe/pull/1582) and [1596](https://github.com/zowe/vscode-extension-for-zowe/pull/1596). Thanks @tiantn and JillieBeanSim | ||
| - Added the new logger API. You can now use the Zowe Explorer API logger functions to standardize messages and specify message severity [#1518](https://github.com/zowe/vscode-extension-for-zowe/pull/1518). Thanks @katelynienaber |
There was a problem hiding this comment.
This changelog item is accurate if the target audience is developers of the ZE FTP extension.
However, if we are addressing end users of the ZE FTP extension, this item might be a bit confusing. The new logger API is not something that the end user will be touching directly. Rather, they will just see that the ZE FTP extension's messages are standardized and have severity specified. I would suggest rewording to something like:
Standardized user interface and log messages with severity specifications using Zowe Explorer API’s logger functions.
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
packages/zowe-explorer/CHANGELOG.md
Outdated
| - Updated Theia tests to use the latest Theia version [#1566](https://github.com/zowe/vscode-extension-for-zowe/pull/1566). Thanks @JillieBeanSim | ||
| - Fixed the issue that caused JCL errors in the JOBS tree to be displayed as `undefined:undefined(undefined)` [#1584](https://github.com/zowe/vscode-extension-for-zowe/pull/1584). Thanks @roman-kupriyanov | ||
| - Fixed the Theia input box issue that caused entered values to be incorrectly validated [#1580](https://github.com/zowe/vscode-extension-for-zowe/pull/1580). Thanks @JillieBeanSim | ||
| - Fixed the issue that caused the removal of unsaved credentials of a profile in the Jobs tree after deleting a job. Now when you delete a job from the Jobs tree with a profile that does not have the stored credentials, the profile keeps the cached credentials [#1449](https://github.com/zowe/vscode-extension-for-zowe/pull/1449). Thanks @JillieBeanSim |
There was a problem hiding this comment.
This PR 1449 is thanks to Nikolay
There was a problem hiding this comment.
@IgorCATech For consistency, I updated the linked reference for this item to PR #1524, which is the PR that fixed issue #1449, as all the other changelog items link to PRs rather than issues.
There was a problem hiding this comment.
Good catch! Thank you for your vigilance and attention to detail
Signed-off-by: ik673626 <igor.kazmyr@broadcom.com>
…r grammar fix Signed-off-by: Lauren Li <45975633+lauren-li@users.noreply.github.com>
There was a problem hiding this comment.
This PR looks good to me! Thanks @IgorCATech for putting this together and working with me on the refinements!
Thanks for your fixes, too, Lauren! |
Signed-off-by: ik673626 igor.kazmyr@broadcom.com
Proposed changes
Update to the Readme (the release notes section) and Changelog for 1.21.0
Release Notes
Milestone:
Changelog: 1.21.0
Types of changes
What types of changes does your code introduce to Zowe Explorer?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the revieweryarn workspace vscode-extension-for-zowe vscode:prepublishhas been executedReminder
After a PR is merged into the
masterbranch, create a PR frommasterto thenextbranch resolving any conflicts.Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...