oras-project / oras

OCI registry client - managing content like artifacts, images, packages
https://oras.land
Apache License 2.0
1.52k stars 181 forks source link

docs: Improve ORAS diagnose experience #1483

Closed FeynmanZhou closed 2 weeks ago

FeynmanZhou commented 3 months ago

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

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features:

FeynmanZhou commented 3 weeks ago

Hi @Wwwsylvia @shizhMSFT , sorry for being late to resolve the remaining comments. I still need your clarification to help finalize the last 3 comments. Thanks