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

rewriting/editing ReadMe file #3484

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

rewriting/editing ReadMe file #3484

wants to merge 6 commits into from

Conversation

anaxceron
Copy link
Contributor

Proposed changes

Editing/rewriting Readme to address Issue 3765

Release Notes

Milestone:

Changelog:

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which adds or improves functionality)
  • Breaking change (a change that would cause existing functionality to not work as expected)
  • [x ] Documentation (Markdown, README updates)
  • Other (please specify above in "Proposed changes" section)

Checklist

General

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • All PR dependencies have been merged and published (if applicable)
  • A GIF or screenshot is included in the PR for visual changes
  • The pre-publish command has been executed:
    • v2 and below: yarn workspace vscode-extension-for-zowe vscode:prepublish
    • v3: pnpm --filter vscode-extension-for-zowe vscode:prepublish

Code coverage

  • There is coverage for the code that I have added
  • I have added new test cases and they are passing
  • I have manually tested the changes

Deployment

  • I have added developer documentation (if applicable)
  • Documentation should be added to Zowe Docs
    • If you're an outside contributor, please post in the #zowe-doc Slack channel to coordinate documentation.
    • Otherwise, please check with the rest of the squad about any needed documentation before merging.
  • These changes may need ported to the appropriate branches (list here):

Further comments

@anaxceron anaxceron added the docs label Feb 25, 2025
@anaxceron anaxceron self-assigned this Feb 25, 2025
Copy link

📅 Suggested merge-by date: 3/11/2025

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.49%. Comparing base (8e57200) to head (c7190f4).

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #3484    +/-   ##
========================================
  Coverage   93.49%   93.49%            
========================================
  Files         120      120            
  Lines       12822    12822            
  Branches     2836     2943   +107     
========================================
  Hits        11988    11988            
  Misses        833      833            
  Partials        1        1            

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JillieBeanSim JillieBeanSim added the no-changelog Add to PR's that don't require a CHANGELOG update label Feb 26, 2025
Copy link
Contributor

@JillieBeanSim JillieBeanSim left a comment

Choose a reason for hiding this comment

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

thanks for working on this @anaxceron left a couple comments on SSO & MFA scenarios

traeok
traeok previously approved these changes Feb 27, 2025
Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

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

These changes look good to me, thanks Ana for revamping our readme! I had a similar question to Billie regarding token login, but I agree with Adam's suggestion to adjust that part of the doc to mention how MFA could work for extenders.

Aside from that, 2 suggestions on conventions but nothing that needs to be changed.

Signed-off-by: anaxceron <[email protected]>
@adam-wolfe
Copy link
Contributor

Sorry for the last-minute comments, I promise I'm done now 😅

Copy link
Contributor

@adam-wolfe adam-wolfe left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @anaxceron

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

LGTM! 😋

Thanks for addressing all the comments 🙏

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

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

Thanks Ana!

@zFernand0
Copy link
Member

Hey @JillieBeanSim, 👋

I believe these requested changes have been addressed 🥳
Please feel free to re-review 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs no-changelog Add to PR's that don't require a CHANGELOG update size/L
Projects
Status: Review/QA
Development

Successfully merging this pull request may close these issues.

5 participants