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

docs: Improve ORAS diagnose experience #1483

Merged
merged 23 commits into from
Nov 20, 2024

Conversation

FeynmanZhou
Copy link
Member

@FeynmanZhou FeynmanZhou commented Aug 19, 2024

What this PR does / why we need it:

This proposal document aims to:

  1. Identify the issues associated with the current implementation of the --verbose and --debug options.
  2. Clarify the concepts of verbose output and debug logs.
  3. List the guiding principles to write comprehensive, clear, and conducive verbose output and debug logs for effective diagnosis.
  4. Propose solutions to improve the diagnostic experience for ORAS CLI users and developers.
  5. Add examples for proposed changes (more examples will be appended).

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1091

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.99%. Comparing base (ebee694) to head (719464b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1483      +/-   ##
==========================================
+ Coverage   83.96%   83.99%   +0.03%     
==========================================
  Files         119      119              
  Lines        5306     5306              
==========================================
+ Hits         4455     4457       +2     
+ Misses        604      602       -2     
  Partials      247      247              

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


🚨 Try these New Features:

Copy link

@toddysm toddysm left a comment

Choose a reason for hiding this comment

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

IMHO, if a user decides to get verbose output, he or she will be prepared to receive a lot of information in the output (including very technical information - for example, curl gives details about the encryption algorithm). I am still not convinced that we need to complicate the interface to suppress some of the output.

docs/proposals/diagnose-experience.md Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
docs/proposals/diagnose-experience.md Outdated Show resolved Hide resolved
Copy link
Member

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

Latest changes lgtm

Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@shizhMSFT shizhMSFT merged commit 9d52592 into oras-project:main Nov 20, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve verbose logging for oras commands
7 participants