Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

review docs for accuracy and update #210

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

davenice
Copy link
Contributor

@davenice davenice commented Jan 19, 2025

What It Does
Resolves #209

How to Test
The easiest place to review the changes look good is https://github.com/zowe/cics-for-zowe-client/blob/niced-update-docs/packages/vsce/README.md

Review Checklist
I certify that I have:

Additional Comments

@codecov-commenter
Copy link

codecov-commenter commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.25%. Comparing base (61f57a8) to head (142793e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #210   +/-   ##
=======================================
  Coverage   28.25%   28.25%           
=======================================
  Files         146      146           
  Lines        4987     4987           
  Branches      869      869           
=======================================
  Hits         1409     1409           
  Misses       3578     3578           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davenice davenice force-pushed the niced-update-docs branch 2 times, most recently from 46358e9 to f05b858 Compare January 19, 2025 22:30
@davenice davenice marked this pull request as ready for review January 19, 2025 22:48
Copy link
Contributor

@AndrewTwydell AndrewTwydell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vast improvement, thanks for taking this one! 😎

davenice and others added 2 commits January 20, 2025 09:44
Co-authored-by: Andrew <[email protected]>
Signed-off-by: Dave Nice <[email protected]>
Signed-off-by: Dave Nice <[email protected]>
@davenice
Copy link
Contributor Author

@zFernand0 - would there be a good person on your side to review this?

@almightyrush almightyrush self-requested a review January 20, 2025 14:11
Copy link
Contributor

@almightyrush almightyrush left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@JTonda JTonda requested a review from anaxceron January 23, 2025 16:05
packages/vsce/README.md Outdated Show resolved Hide resolved
packages/vsce/README.md Outdated Show resolved Hide resolved

**Tip:** The default 500 count can be modified via the `Record Count Increment` property in Settings (UI).
**Tip:** The default 500 count can be modified via the `Record Count Increment` property in Settings (UI). **[What does "(UI)" mean here? I don't see it in the screenshot.]**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davenice - please respond

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UI means the settings page in VS Code rather than the config file, I imagine. Please check my clarified wording @anaxceron

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(In fact I found another place where we talk about the settings and have now taken the wording from there!)


<p align="center">
<img src="/packages/vsce/docs/images/disable-enable.gif" alt="Zowe CICS Explorer Filter" width="700px"/>
</p>

### New Copy and Phase In

Use `New Copy` <img src="/packages/vsce/docs/images/program-newcopy-action.png" width="16px"/> and `Phase In` <img src="/packages/vsce/docs/images/program-phasein-action.png" width="16px"/> actions against a CICS program to get the CICS region to load a fresh of the selected program into memory. This could be after you've edited a COBOL program source and successfully compiled it into a load library and now want to test your change.
Use `New Copy` <img src="/packages/vsce/docs/images/program-newcopy-action.png" width="16px"/> and `Phase In` <img src="/packages/vsce/docs/images/program-phasein-action.png" width="16px"/> actions against a CICS program to get the CICS region to load a fresh of **[is there a word missing here? "a fresh of" what?]** the selected program into memory. This could be after you have edited a COBOL program source and successfully compiled it into a load library so that you can test your change.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davenice - please respond

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - I've updated the wording to be inspired by the CICS doc - https://www.ibm.com/docs/en/cics-ts/5.6?topic=sc-set-program

I hadn't spotted this flagrant typo! Good catch :-)

Signed-off-by: Dave Nice <[email protected]>
@davenice
Copy link
Contributor Author

@anaxceron - I think I've addressed everything you mentioned and this PR is good to go again from my perspective, assuming you agree with what I've done!

Signed-off-by: Dave Nice <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review/QA
Development

Successfully merging this pull request may close these issues.

Update documentation to match the V3 profile changes and review for accuracy
5 participants